cerc-io/snowballtools-base
16
0
Fork 2
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
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
1 changed files with 184 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@ -2,46 +2,40 @@
## Setup ## Setup
### Clone the `snowballtools-base` repo - Clone the `snowballtools-base` repo
```bash ```bash
git clone git@github.com:snowball-tools/snowballtools-base.git git clone git@github.com:snowball-tools/snowballtools-base.git
cd snowballtools-base cd snowballtools-base
``` ```
### Install dependencies in root - Install dependencies in root
```bash ```bash
yarn yarn
``` ```
### Build packages - Build packages
```bash ```bash
yarn build --ignore frontend 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`
- For Backend: - Configuration Files
- For Backend:
```bash ```bash
cp packages/backend/environments/local.toml.example packages/backend/environments/local.toml cp packages/backend/environments/local.toml.example packages/backend/environments/local.toml
``` ```
- For Frontend: - Production
```bash - Update the following in backend [config file](packages/backend/environments/local.toml)
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`
- Update the following in backend [config file](packages/backend/environments/local.toml)
```toml ```toml
[server] [server]
@ -57,20 +51,20 @@
domain = "" domain = ""
``` ```
- Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml) - 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) - [OAuth App Creation](https://github.com/organizations/<org>/settings/applications/new)
- Homepage URL: `https://dashboard.snowballtools.com` - Homepage URL: `https://dashboard.snowballtools.com`
- Authorization callback URL: `https://dashboard.snowballtools.com/organization/projects/create` - Authorization callback URL: `https://dashboard.snowballtools.com/organization/projects/create`
- Generate a new client secret after app is created - Generate a new client secret after app is created
- Set `gitHub.webhookUrl` in backend [config file](packages/backend/environments/local.toml) - Set `gitHub.webhookUrl` in backend [config file](packages/backend/environments/local.toml)
```toml ```toml
[gitHub] [gitHub]
webhookUrl = "https://api.snowballtools.com" webhookUrl = "https://api.snowballtools.com"
``` ```
- Let us assume domain for Laconicd to be `api.laconic.com` and set the following in backend [config file](packages/backend/environments/local.toml) - Let us assume domain for Laconicd to be `api.laconic.com` and set the following in backend [config file](packages/backend/environments/local.toml)
```toml ```toml
[registryConfig] [registryConfig]
@ -92,15 +86,15 @@
gas = "750000" gas = "750000"
``` ```
### Backend Development - Development
- Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml) - 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) - [OAuth App Creation](https://github.com/organizations/<org>/settings/applications/new)
- Homepage URL: `http://localhost:3000` - Homepage URL: `http://localhost:3000`
- Authorization callback URL: `http://localhost:3000/organization/projects/create` - Authorization callback URL: `http://localhost:3000/organization/projects/create`
- Generate a new client secret after app is created - Generate a new client secret after app is created
- Setup Laconicd - Setup Laconicd
- Run the laconicd stack following this [doc](https://git.vdb.to/cerc-io/stack-orchestrator/src/branch/main/docs/laconicd-with-console.md) - Run the laconicd stack following this [doc](https://git.vdb.to/cerc-io/stack-orchestrator/src/branch/main/docs/laconicd-with-console.md)
- Get the private key and set `registryConfig.privateKey` in backend [config file](packages/backend/environments/local.toml) - Get the private key and set `registryConfig.privateKey` in backend [config file](packages/backend/environments/local.toml)
@ -133,7 +127,7 @@
- Get the bond id and set `registryConfig.bondId` in backend [config file](packages/backend/environments/local.toml) - Get the bond id and set `registryConfig.bondId` in backend [config file](packages/backend/environments/local.toml)
- Setup ngrok for GitHub webhooks - Setup ngrok for GitHub webhooks
- [ngrok getting started](https://ngrok.com/docs/getting-started/) - [ngrok getting started](https://ngrok.com/docs/getting-started/)
- Start ngrok and point to backend server endpoint - Start ngrok and point to backend server endpoint
@ -154,40 +148,34 @@
webhookUrl = "https://19c1-61-95-158-116.ngrok-free.app" webhookUrl = "https://19c1-61-95-158-116.ngrok-free.app"
``` ```
## Frontend - For Frontend:
- Change directory to `packages/frontend` in a new terminal
```bash ```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 - Copy the GitHub OAuth app client ID from previous steps and set it in frontend [.env](packages/frontend/.env) file
```env ```env
REACT_APP_GITHUB_CLIENT_ID = <CLIENT_ID> REACT_APP_GITHUB_CLIENT_ID = <CLIENT_ID>
``` ```
- Set `REACT_APP_GITHUB_PWA_TEMPLATE_REPO` and `REACT_APP_GITHUB_IMAGE_UPLOAD_PWA_TEMPLATE_REPO` in [.env](packages/frontend/.env) file - Set `REACT_APP_GITHUB_PWA_TEMPLATE_REPO` and `REACT_APP_GITHUB_IMAGE_UPLOAD_PWA_TEMPLATE_REPO` in [.env](packages/frontend/.env) file
```env ```env
REACT_APP_GITHUB_PWA_TEMPLATE_REPO = 'cerc-io/test-progressive-web-app' # Set actual owner/name of the template repo that will be used for creating new repo REACT_APP_GITHUB_PWA_TEMPLATE_REPO = 'cerc-io/test-progressive-web-app' # Set actual owner/name of the template repo that will be used for creating new repo
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 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 - Production
- Let us assume the following domains for backend and frontend - Set the following values in [.env](packages/frontend/.env) file
- Backend server: `api.snowballtools.com`
- Frontend app: `dashboard.snowballtools.com`
- Set the following values in [.env](packages/frontend/.env) file
```env ```env
REACT_APP_SERVER_URL = 'https://api.snowballtools.com' # Backend server endpoint REACT_APP_SERVER_URL = 'https://api.snowballtools.com' # Backend server endpoint
``` ```
- Sign in to [wallet connect](https://cloud.walletconnect.com/sign-in) to create a project ID - Sign in to [wallet connect](https://cloud.walletconnect.com/sign-in) to create a project ID
- Create a project and add information to use wallet connect SDK - Create a project and add information to use wallet connect SDK
- Add project name and select project type as `App` - Add project name and select project type as `App`
- Set project home page URL to `https://dashboard.snowballtools.com` - Set project home page URL to `https://dashboard.snowballtools.com`
@ -197,27 +185,27 @@
REACT_APP_WALLET_CONNECT_ID = <PROJECT_ID> REACT_APP_WALLET_CONNECT_ID = <PROJECT_ID>
``` ```
- Build the React application - Build the React application
```bash ```bash
yarn build yarn build
``` ```
- Use a web server for hosting static built files - Use a web server for hosting static built files
```bash ```bash
python3 -m http.server -d build 3000 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` - Copy the graphQL endpoint from terminal and add the endpoint in the [.env](packages/frontend/.env) file present in `packages/frontend`
```env ```env
REACT_APP_SERVER_URL = 'http://localhost:8000' REACT_APP_SERVER_URL = 'http://localhost:8000'
``` ```
- Sign in to [wallet connect](https://cloud.walletconnect.com/sign-in) to create a project ID. - Sign in to [wallet connect](https://cloud.walletconnect.com/sign-in) to create a project ID.
- Create a project and add information to use wallet connect SDK - Create a project and add information to use wallet connect SDK
- Add project name and select project type as `App` - Add project name and select project type as `App`
- Project home page URL is not required to be set - Project home page URL is not required to be set
@ -227,7 +215,7 @@
REACT_APP_WALLET_CONNECT_ID = <Project_ID> REACT_APP_WALLET_CONNECT_ID = <Project_ID>
``` ```
- The React application will be running in `http://localhost:3000/` - The React application will be running in `http://localhost:3000/`
## Development ## Development