Running the Project

yarn install
# or
npm install

Development

To start the project locally, run:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Requirements

• Node.js >= 12.22.0
• Yarn 1 (Classic)

Scripts

• yarn dev — Starts the application in development mode at http://localhost:3000.
• yarn build — Creates an optimized production build of your application.
• yarn start — Starts the application in production mode.
• yarn type-check — Validate code using TypeScript compiler.
• yarn lint — Runs ESLint for all files in the src directory.
• yarn format — Runs Prettier for all files in the src directory.
• yarn commit — Run commitizen. Alternative to git commit.

Using to npm

By default, this project uses Yarn 1 (Classic), but this choice is yours. If you'd like to switch to npm, delete the yarn.lock file, install the dependencies with npm install, and change the CI workflows, Husky Git hooks, and lint-staged steps to use npm commands.

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.