mycookbook / web-app

MyCookbook HQ Web Application

MyCookbook HQ Web application built with Vue 3, Nuxt 3 and Typescript

Plugins

Which helps to maintain project code quality.

• Prettier
• Eslint
• Stylelint
• Lint-staged
• Commitlint
• Standard version

Before getting started

Make sure you have installed Node.js 16.11.0 or higher on your machine. You can use nvm to manage multiple node version on your machine.

nvm install 16.11.0
nvm use

Getting started

You can setup this project using npm package.

Clone repo

# ssh
git clone [e-mail]:mycookbook/web-app.git

Navigate to cloned repo

cd web-app

Setup

Make sure to install the dependencies:

# npm
npm install

Development Server

Start the development server on http://localhost:3000

# npm
npm run dev

Production

Build the application for production

# npm
npm run build

Locally preview production build

# npm
npm run preview

Lint

# npm
npm run lint

Lint fix

# npm
npm run lint:fix

Lint style

# npm
npm run lint:style

Lint style fix

# npm
npm run lint:style:fix

Commit

Open interactive terminal to write conventional commit message

# npm
npm run commit

Release

Create a release tag and generates change log based on commit history

# npm
npm run release

References

• Checkout the deployment documentation for more information.