Run the following command from the project root directory in your terminal:
cp .env.example .env
Set the necessary variables. Ask another team member if you think you are missing any. You will at least need...
API_HOST=//cover.local:3000
Add 127.0.0.1 cover.local
to /etc/hosts
(or equivalent for your OS)
Install the dependencies...
npm i
...then start Rollup:
npm run local:dev
or
make
Install the dependencies...
bun i
...then start Rollup:
bun run bun:dev
or
make bun
Note: this won't update package-lock.json so if you change dependencies you will need to run npm install
to do so.
Navigate to http://cover.local:8081. You should see your app running app (configured to auto-reload page for any changes).
Install the dependencies...
docker-compose run --rm app npm install
...then start Rollup:
docker-compose up -d app
docker-compose logs -f app
or, to run the install and dev scripts in sequence
make docker
Navigate to http://cover.local:8081. You should see your app running app. It will auto-rebuild on code changes.
npm run local:prod
or
make local-prod
NOTE: This mode will not auto-reload when making changes in
src
.
npm run clean
or
make clean
Build the optimized app...
npm run build:prod
or
make build-prod
...then deploy contents of dist
to your host.
This code uses Material Design icons. To search for additional icons, go here: https://fonts.google.com/icons