Update README.md: replace team-monitor-website with vibinex-server #72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe changes made to the README.md file primarily involve the shift from the "team-monitor-website" repository to the "vibinex-server" repository. This includes changes in the repository to be cloned, the location for pasting the client id and secret, the URL in the .env.local file, and the command to start the server. Changes
TipsChat with CodeRabbit Bot (
|
|
Kudos, SonarCloud Quality Gate passed!
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (2 hunks)
Additional comments: 1
README.md (1)
- 50-53: No changes were made in this hunk. The license information is clear and concise.
Comment on lines
15
to
24
| 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". |
There was a problem hiding this comment.
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.
MuskanPaliwal
approved these changes
Nov 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check the action items covered in the PR -
Summary by CodeRabbit