Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (17 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 1.05 KB

crawler && search

See crawler README.

api && frontend

Installation

Requirements:

Oneliner command to install packages for both from the main project folder:

yarn --cwd api && yarn --cwd frontend

Alternatively install for a specific folder by first running cd api or cd frontend then simply yarn.

Dev Scripts

  • Develop locally: Run yarn run dev in the folder of the service you're running (api or frontend).
    • The frontend client will be running at localhost:3000. (yarn start for frontend does the same thing).
    • The backend api will be running at localhost:8080.
  • Format files: Run yarn run format. This will happen automatically whenever you commit anyway.

Useful Tips

  • If you want to run a script for a service without having to cd into the folder first you can add --cwd <folder path> before the command. (ex: yarn --cwd api run dev)