Update README.md

This commit is contained in:
Vivian Phung 2024-02-29 21:59:41 -07:00 committed by GitHub
parent 22f3cbafb7
commit 5be6e14db9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2,26 +2,30 @@
## Setup
### Clone the `snowballtools-base` repo
- Clone the `snowballtools-base` repo
```bash
git clone git@github.com:snowball-tools/snowballtools-base.git
cd snowballtools-base
```
### Install dependencies in root
- Install dependencies in root
```bash
yarn
```
### Build packages
- Build packages
```bash
yarn build --ignore frontend
```
### Configuration Files
Let us assume the following domains for backend and frontend
- Backend server: `api.snowballtools.com`
- Frontend app: `dashboard.snowballtools.com`
- Configuration Files
- For Backend:
@ -29,17 +33,7 @@
cp packages/backend/environments/local.toml.example packages/backend/environments/local.toml
```
- For Frontend:
```bash
cp packages/frontend/.env.example packages/frontend/.env
```
### Backend Production
- Let us assume the following domains for backend and frontend
- Backend server: `api.snowballtools.com`
- Frontend app: `dashboard.snowballtools.com`
- Production
- Update the following in backend [config file](packages/backend/environments/local.toml)
@ -92,7 +86,7 @@
gas = "750000"
```
### Backend Development
- Development
- Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml)
- [OAuth App Creation](https://github.com/organizations/<org>/settings/applications/new)
@ -154,12 +148,10 @@
webhookUrl = "https://19c1-61-95-158-116.ngrok-free.app"
```
## Frontend
- Change directory to `packages/frontend` in a new terminal
- For Frontend:
```bash
cd packages/frontend
cp packages/frontend/.env.example packages/frontend/.env
```
- Copy the GitHub OAuth app client ID from previous steps and set it in frontend [.env](packages/frontend/.env) file
@ -175,11 +167,7 @@
REACT_APP_GITHUB_IMAGE_UPLOAD_PWA_TEMPLATE_REPO = 'cerc-io/image-upload-pwa-example' # Set actual owner/name of the template repo that will be used for creating new repo
```
### Frontend Production
- Let us assume the following domains for backend and frontend
- Backend server: `api.snowballtools.com`
- Frontend app: `dashboard.snowballtools.com`
- Production
- Set the following values in [.env](packages/frontend/.env) file
@ -209,7 +197,7 @@
python3 -m http.server -d build 3000
```
### Frontend Development
- Development
- Copy the graphQL endpoint from terminal and add the endpoint in the [.env](packages/frontend/.env) file present in `packages/frontend`