snowballtools-base-mirror/README.md
Nabarun Gogoi 7e2a313012
Implement functionality to add and delete Deploy webhooks (#47)
* Add mutation to add webhooks

* Implement frontend to add webhooks and refactor code to use updateProject resolver

* Implement functionality to delete webhooks

* Refactor webhook card component

* Update readme for frontend env GitHub OAuth client ID

---------

Co-authored-by: neeraj <neeraj.rtly@gmail.com>
2024-02-01 14:04:07 +05:30

71 lines
1.5 KiB
Markdown

# snowballtools
- Clone the `snowballtools` repo
```bash
git clone git@github.com:snowball-tools/snowballtools-base.git
```
- In root of the repo, install depedencies
```bash
yarn
```
- Build packages
```bash
yarn build --ignore frontend
```
- Change directory to `packages/backend`
```bash
cd packages/backend
```
- Load fixtures in database
```bash
yarn db:load:fixtures
```
- Set `githubOauth.clientId` and `githubOauth.clientSecret` in backend [config file](packages/backend/environments/local.toml)
- Client ID and secret will be available after creating Github 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/projects/create`
- Generate a new client secret after app is created
- Start the server
```bash
yarn start
```
- Change directory to `packages/frontend` in a new terminal
```bash
cd packages/frontend
```
- Copy the graphQL endpoint from terminal and add the endpoint in the [.env](packages/frontend/.env) file present in `packages/frontend`
```
REACT_APP_GQL_SERVER_URL = 'http://localhost:8000/graphql'
```
- Copy the GitHub OAuth app client ID from previous steps and set it in frontend [.env](packages/frontend/.env) file
```
REACT_APP_GITHUB_CLIENT_ID = <CLIENT_ID>
```
- Start the React application
```bash
yarn start
```
- The React application will be running in `http://localhost:3000/`