snowballtools-base/packages/frontend/README.md

64 lines
1.0 KiB
Markdown
Raw Normal View History

2024-06-22 22:05:26 +00:00
# frontend
2024-06-22 22:05:26 +00:00
This is a [vite](https://vitejs.dev/) [react](https://reactjs.org/) [nextjs](https://nextjs.org/) project in a [yarn workspace](https://yarnpkg.com/features/workspaces).
2024-06-22 22:05:26 +00:00
## Getting Started
2024-06-22 22:05:26 +00:00
### Install dependencies
2024-06-22 22:05:26 +00:00
In the root of the project, run:
2024-06-22 22:05:26 +00:00
```zsh
yarn
```
### Build backend
```zsh
yarn build --ignore-frontend
```
### Environment variables
#### Local
Copy the `.env.example` file to `.env`:
```zsh
cp .env.example .env
```
#### Staging environment variables
Change in [deployer/deploy-frontend.staging.sh](/packages/deployer/deploy-frontend.staging.sh)
2024-06-22 22:05:26 +00:00
#### Production environment variables
2024-06-22 22:05:26 +00:00
Change in [deployer/deploy-frontend.sh](/packages/deployer/deploy-frontend.sh)
### Run development server
```zsh
yarn dev
2024-04-11 21:40:22 +00:00
```
2024-06-22 22:05:26 +00:00
## Deployment
From the root of the project, run:
### Staging
```zsh
cd packages/deployer && ./deploy-frontend.staging.sh
```
### Production
```zsh
cd packages/deployer && ./deploy-frontend.sh
```
### Deployment status
Check the status of the deployment [here](https://webapp-deployer.apps.snowballtools.com)