The EDPN frontend project handles the web application for the Elite Dangerous Pilots Network Website. It consumes the EDPN Backend API to support its features.
First, clone this repo:
git clone https://github.com/ed-pilots-network/frontend.gitThen, install dependencies with:
yarn installyarn dev-apiOpen http://localhost:3000 with your browser to see the web app while API runs on http://localhost:3001.
yarn devOpen http://localhost:3000 with your browser to see the result.
yarn apiOpen http://localhost:3001 with your browser to see the API endpoint. Read more on JSON Server
yarn buildyarn lintyarn testRemoves the .next and node_modules folders and runs yarn install to clean up the local workspace
yarn cleanIf you are making changes that impact the UI, ensure to test the change on different view ports. Run the following to auto capture screenshots when tests run. Note that this only runs when you run this command locally.
yarn capture-screenshotsPAGE_PATH=/commodities yarn capture-screenshotsEnter the values in the .env for localhost and .env.development.sample, .env.production.sample for respective environments. Only change docker folder files if you are involved in managing deployment to these stages.
make build-development
make start-development
make build-production
make start-production
First, run the development server:
yarn dev- NextJS as a framework.
- Jest and Playwright for unit and end-to-end testing respectively.
- Typescript
- Eslint
- Prettier
- Husky
- Docker
- ColorKit - Color Palette Generator