Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setup instructions and description to Readme #9

Merged
merged 4 commits into from
Sep 20, 2023
Merged

Add setup instructions and description to Readme #9

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e831f1d
Add instructions about oauth and setup
tapishr Sep 20, 2023
472345e
Merge branch 'main' into tr/readme
tapishr Sep 20, 2023
eb01845
Add what happens on port 3000 in instructions
tapishr Sep 20, 2023
1263cfc
Merge branch 'tr/readme' of github.com:Alokit-Innovations/vibi-dpu in…
tapishr Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would be running on 3000 port? The first line doesn't clarify this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ For more information, visit our website at https://vibinex.com/.
To run Vibi-DPU locally:

1. Generate public url using ngrok - `ngrok http 3000`
2. Fire up cloud sql proxy - `./cloud-sql-proxy --port 5432 vibi-test-394606:asia-south1:test-db`
3. Change url in team-monitor-website in .env.local - `NEXTAUTH_URL=https://example.ngrok-free.app`
4. Start team-monitor-website - `npm run dev`
5. Build vibi-dpu, go to vibi-dpu/vibi-dpu and run - `cargo build`
6. Go up to the root directory of vibi-dpu - `cd ../`
7. **Build the Docker image**: In the root directory of the project, run the following command to build a Docker image with the name "dpu".
2. Paste this in OAuth consumers in callback_url field.
3. Clone [team-monitor-webiste](https://github.com/Alokit-Innovations/team-monitor-website/) locally.
4. Paste the client id and secret in team-monitor-wesite in .env.local in root directory. Also use them in the docker command below.
5. Fire up cloud sql proxy - `./cloud-sql-proxy --port 5432 vibi-test-394606:asia-south1:test-db`
6. Change url in team-monitor-website in .env.local - `NEXTAUTH_URL=https://example.ngrok-free.app`
7. Start team-monitor-website - `npm run dev`
8. Build vibi-dpu, go to vibi-dpu/vibi-dpu and run - `cargo build`
9. Go up to the root directory of vibi-dpu - `cd ../`
10. **Build the Docker image**: In the root directory of the project, run the following command to build a Docker image with the name "dpu".

```bash
docker build \
Expand All @@ -32,11 +35,14 @@ To run Vibi-DPU locally:
--build-arg SERVER_URL=your-server-url \
-t dpu .
```
8. **Run the Docker container**: After building the image, you can run it using the following command.
11. **Run the Docker container**: After building the image, you can run it using the following command.

```bash
docker run dpu
```
12. For bitbucket, replace your url in this url and paste it on your browser and visit it. If you are using ngrok, you might get a "visit site" ngrok welcome page. Click and visit site. Grant any permissions asked from your user to bitbucket. Example URL - `https://bitbucket.org/site/oauth2/authorize?response_type=code&client_id=raFykYJRvEBHPttQAm&redirect_uri=https%3A%2F%2F5bef-171-76-86-89.ngrok-free.app%2Fapi%2Fbitbucket%2Fcallbacks%2Finstall&scope=repository%20pullrequest%20pullrequest:write%20webhook%20account%20repository:write`. You only need to replace the `5bef-171-76-86-89.ngrok-free.app` part with your own ngrok url instead of generating a new formatted url.
13. This would start the "setting up" part of dpu, where it calls bitbucket apis and collects repo info, user info, workspace info and pr info.
14. Next begin your testing. For instance, if you push to a PR, you should be able to see logs in next server, in dpu and see the required actions being performed on the PR.

## Contributing

Expand Down