hypertuner-cloud/DEVELOPMENT.md

48 lines
777 B
Markdown
Raw Permalink Normal View History

2022-01-09 14:33:38 -08:00
# Development guide
This guide will help you set up this project.
2023-07-13 02:33:10 -07:00
## Using GitHub Codespaces
This project is configured to work with GitHub [Codespaces](https://github.com/features/codespaces). To use it, simply open the project in a Codespace using GitHub's UI.
## Local development
### Requirements
2022-01-09 14:33:38 -08:00
2022-07-17 11:55:10 -07:00
- Node Version Manager: [nvm](https://github.com/nvm-sh/nvm)
2022-01-09 14:33:38 -08:00
2023-07-13 02:33:10 -07:00
#### Setup local environment variables
2022-01-09 14:33:38 -08:00
```bash
cp .env .env.local
```
2023-07-13 02:33:10 -07:00
#### Setup correct Node.js version
2022-07-17 11:55:10 -07:00
```bash
nvm use
```
2023-07-13 02:33:10 -07:00
#### Install dependencies and run in development mode
2022-01-09 14:33:38 -08:00
```bash
# install packages
npm install
# run development server
npm start
2022-10-30 09:09:26 -07:00
# lint code
npm run lint
2022-11-21 14:09:57 -08:00
# fix / format code
npm run lint:fix
# regenerate PocketBase types
npm run typegen
2022-10-30 09:09:26 -07:00
# production build
npm run build
2022-01-09 14:33:38 -08:00
```