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

updating readme #294

Merged
merged 1 commit into from
Jun 21, 2024
Merged

updating readme #294

merged 1 commit into from
Jun 21, 2024

Conversation

aarushik93
Copy link
Contributor

@aarushik93 aarushik93 commented Jun 21, 2024

User description

updating readme to include details on running the frontend and environment variables


PR Type

documentation


Description

  • Added a new section to the README for configuring environment variables, including instructions for copying the .env.example file to .env and filling out necessary variables.
  • Updated the step numbers throughout the README to accommodate the new section.
  • Included a reminder to run the frontend from the frontend/ folder.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Update README with environment variables and frontend instructions

README.md

  • Added a new section for configuring environment variables.
  • Updated step numbers to reflect the new section.
  • Included instructions for running the frontend from the correct
    directory.
  • +26/-6   

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @qodo-merge-pro qodo-merge-pro bot added the documentation Improvements or additions to documentation label Jun 21, 2024
    Copy link

    PR Description updated to latest commit (c457d45)

    Copy link

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 1
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review None

    @aarushik93 aarushik93 merged commit a77e1f0 into main Jun 21, 2024
    3 checks passed
    @aarushik93 aarushik93 deleted the update-setup-readme branch June 21, 2024 22:15
    Copy link

    PR Code Suggestions ✨

    No code suggestions found for PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant