a4d9211ffe
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. ---
24 lines
497 B
Markdown
24 lines
497 B
Markdown
# snowballtools-base
|
|
|
|
This is a [yarn workspace](https://yarnpkg.com/features/workspaces) monorepo for the dashboard.
|
|
|
|
## Getting Started
|
|
|
|
### Install dependencies
|
|
|
|
In the root of the project, run:
|
|
|
|
```zsh
|
|
yarn
|
|
```
|
|
|
|
### Build backend
|
|
|
|
```zsh
|
|
yarn build --ignore-frontend
|
|
```
|
|
|
|
### Environment variables, running the development server, and deployment
|
|
|
|
Follow the instructions in the README.md files of the [backend](packages/backend/README.md) and [frontend](packages/frontend/README.md) packages.
|