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.

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

Conversation

tapishr
Copy link
Member

@tapishr tapishr commented Sep 20, 2023

Added instructions to run the application locally and for what it is used.
Raising this PR again, as I missed a few instructions. Reverted the previous PR as I wanted to experience the revert of a PR and this was low LOGAF change.

Summary by CodeRabbit

  • Documentation: Updated the README.md with detailed setup instructions for running Vibi-DPU locally. This includes steps for cloning the repository, building the Docker image, and running the container.
  • New Feature: Added information about Vibi-DPU's integration with Bitbucket and the Next.js server, enhancing the application's functionality and interoperability.
  • Chore: Packaged Vibi-DPU as a Docker image, facilitating easy deployment and ensuring consistent runtime environment.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 20, 2023

Rate Limit Exceeded

You have exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 3 minutes and 12 seconds before requesting another review.

To re-trigger a review, convert this PR to a draft and then mark it as ready for review again. Alternatively, you can push a new commit to this PR.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 20, 2023

Walkthrough

The changes primarily focus on enhancing the documentation of the Vibi-DPU application. This includes detailed setup instructions for local deployment, information about its integration with Bitbucket and Next.js server, and how to build and run the Docker image.

Changes

File Summary
README.md Updated with comprehensive setup instructions for running Vibi-DPU locally, building the Docker image, and running the container. Also added details about the application's integration with Bitbucket and the Next.js server.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 342c6c6 and 472345e.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 20, 2023

Rate Limit Exceeded

You have exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 14 minutes and 29 seconds before requesting another review.

To re-trigger a review, convert this PR to a draft and then mark it as ready for review again. Alternatively, you can push a new commit to this PR.

@sonarcloud
Copy link

sonarcloud bot commented Sep 20, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@MuskanPaliwal MuskanPaliwal merged commit 8cdbcc5 into main Sep 20, 2023
3 checks passed
@tapishr tapishr deleted the tr/readme branch November 22, 2023 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants