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

Merge pull request #140 from snowball-tools/readme-cleanup

Browse Source 
readme
This commit is contained in:
Vivian Phung 2024-03-15 15:05:36 -04:00 committed by GitHub
commit 44a6a8902f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 201 additions and 238 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

143
README.md
View File

@ -6,9 +6,10 @@
```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
``` ```
- In root of the repo, install depedencies - Install dependencies in root
```bash ```bash
yarn yarn
@ -20,33 +21,21 @@
yarn build --ignore frontend yarn build --ignore frontend
``` ```
## Backend Let us assume the following domains for backend and frontend
- Change directory to `packages/backend`
```bash
cd packages/backend
```
- Rename backend config file from [environments/local.toml.example](packages/backend/environments/local.toml.example) to `local.toml`
```bash
mv environments/local.toml.example environments/local.toml
```
- Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml)
- Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
- In "Homepage URL", type `http://localhost:3000`
- In "Authorization callback URL", type `http://localhost:3000/organization/projects/create`
- Generate a new client secret after app is created
### Backend Production
- Let us assume the following domains for backend and frontend
- Backend server: `api.snowballtools.com` - Backend server: `api.snowballtools.com`
- Frontend app: `dashboard.snowballtools.com` - Frontend app: `dashboard.snowballtools.com`
- Update the following in backend [config file](packages/backend/environments/local.toml) - Configuration Files
- For Backend:
```bash
cp packages/backend/environments/local.toml.example packages/backend/environments/local.toml
```
- Production
- Update the following in backend [config file](packages/backend/environments/local.toml)
```toml ```toml
[server] [server]
@ -62,25 +51,22 @@
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)
- Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - [OAuth App Creation](https://github.com/organizations/<org>/settings/applications/new)
- In "Homepage URL", type `https://dashboard.snowballtools.com` - Homepage URL: `https://dashboard.snowballtools.com`
- In "Authorization callback URL", type `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]
fetchDeploymentRecordDelay = 5000 fetchDeploymentRecordDelay = 5000
# Use actual port for REST endpoint # Use actual port for REST endpoint
@ -98,24 +84,17 @@
amount = "200000" amount = "200000"
denom = "aphoton" denom = "aphoton"
gas = "750000" gas = "750000"
...
``` ```
- Start the server in `packages/backend` - Development
```bash - Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml)
yarn start - [OAuth App Creation](https://github.com/organizations/<org>/settings/applications/new)
``` - Homepage URL: `http://localhost:3000`
- Authorization callback URL: `http://localhost:3000/organization/projects/create`
### Backend Development
- Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml)
- Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
- In "Homepage URL", type `http://localhost:3000`
- In "Authorization callback URL", type `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)
@ -148,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
@ -159,68 +138,44 @@
- Look for the forwarding URL in ngrok - Look for the forwarding URL in ngrok
```bash ```bash
...
Forwarding https://19c1-61-95-158-116.ngrok-free.app -> http://localhost:8000 Forwarding https://19c1-61-95-158-116.ngrok-free.app -> http://localhost:8000
...
``` ```
- 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://19c1-61-95-158-116.ngrok-free.app" webhookUrl = "https://19c1-61-95-158-116.ngrok-free.app"
...
``` ```
- Start the server in `packages/backend` - For Frontend:
```bash ```bash
yarn start:dev cp packages/frontend/.env.example packages/frontend/.env
``` ```
## Frontend - Copy the GitHub OAuth app client ID from previous steps and set it in frontend [.env](packages/frontend/.env) file
- Change directory to `packages/frontend` in a new terminal
```bash
cd packages/frontend
```
- Rename [.env.example](packages/frontend/.env.example) to `.env`
```bash
mv .env.example .env
```
- 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
# 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_PWA_TEMPLATE_REPO = cerc-io/test-progressive-web-app 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
``` ```
### 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
# Backend server endpoint REACT_APP_SERVER_URL = 'https://api.snowballtools.com' # Backend server endpoint
REACT_APP_SERVER_URL = 'https://api.snowballtools.com'
``` ```
- 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`
@ -230,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
@ -260,10 +215,18 @@
REACT_APP_WALLET_CONNECT_ID = <Project_ID> REACT_APP_WALLET_CONNECT_ID = <Project_ID>
``` ```
- Start the React application - The React application will be running in `http://localhost:3000/`
## Development
- Start the backend server
```bash
yarn start:backend
```
- Start the frontend
```bash ```bash
yarn start yarn start
``` ```
- The React application will be running in `http://localhost:3000/`