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

Update README.md: replace team-monitor-website with vibinex-server #72

Merged
merged 1 commit into from
Nov 4, 2023
Merged

Update README.md: replace team-monitor-website with vibinex-server #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ To run Vibi-DPU locally:

1. Generate public url using ngrok - `ngrok http 3000`. We will run our next server locally on port 3000 in later steps.
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.
3. Clone [vibinex-server](https://github.com/Alokit-Innovations/vibinex-server/) locally.
4. Paste the client id and secret in vibinex-server 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`
6. Change url in vibinex-server in .env.local - `NEXTAUTH_URL=https://example.ngrok-free.app`
7. Start vibinex-server - `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".
Comment on lines 15 to 24
Copy link
Contributor

Choose a reason for hiding this comment

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

The instructions are clear and concise. However, it would be helpful to add a note about the prerequisites, such as having Docker, npm, and ngrok installed, and having a GitHub account with the necessary permissions to clone the repository and create OAuth consumers. Also, it would be beneficial to add a note about the need to replace placeholders with actual values in the .env.local file and Docker build command.

Expand Down Expand Up @@ -50,4 +50,4 @@ We welcome contributions from the community! Please read our contributing guidel

## License

This project is licensed under the terms of the GNU-GPLv3.
This project is licensed under the terms of the GNU-GPLv3.
Loading