Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 1.21 KB

README.md

File metadata and controls

54 lines (31 loc) · 1.21 KB
Raw

shoodies

Application to help shodoers to choose their goodies

Getting Started

Prerequisites

Use the package manager npm to install dependencies.

If you need to install node and npm, you can use nvm

  • Node.js >= 18.14
  • Npm >= 9.5

Installation

Run the following command directly from root folder to install dependencies:

npm ci

Note: you don't have to install dependencies for each package, the root package.json will install all dependencies for you

Usage

Development

Frontend:

To start the frontend in development mode, run the following command:

npm run dev -w frontend

Tools

Linting

Eslint is used to lint the code. To run the linter, run the following command:

npm run lint

You can install the eslint extension for your IDE to see linting errors in your code.

Note: Eslint will help you sort your imports automatically. It has been configured only for vscode. If you use another IDE, you will have to configure it yourself.

Formatting

Prettier is used to format the code. You can install the prettier extension for your IDE to format the code on save.