snowballtools-base/packages/frontend/README.md
Vivian Phung a4d9211ffe
Refactor(README.md) (#217)
This pull request refactors the main `README.md` by removing detailed backend and frontend setup instructions and adding separate `README.md` files for the backend and frontend with their specific setup and deployment instructions. This makes the main `README.md` cleaner and directs users to specific READMEs for backend and frontend setups.

---
2024-06-22 18:07:47 -04:00

1.0 KiB

frontend

This is a vite react nextjs project in a yarn workspace.

Getting Started

Install dependencies

In the root of the project, run:

yarn

Build backend

yarn build --ignore-frontend

Environment variables

Local

Copy the .env.example file to .env:

cp .env.example .env

Staging environment variables

Change in deployer/deploy-frontend.staging.sh

Production environment variables

Change in deployer/deploy-frontend.sh

Run development server

yarn dev

Deployment

From the root of the project, run:

Staging

cd packages/deployer && ./deploy-frontend.staging.sh

Production

cd packages/deployer && ./deploy-frontend.sh

Deployment status

Check the status of the deployment here