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

Update README to Include MongoDB Setup Instructions and Endpoint Data Population #255

Open
2 tasks
aditya4196 opened this issue Oct 27, 2023 · 1 comment
Open
2 tasks
Assignees

Comments

@aditya4196
Copy link

aditya4196 commented Oct 27, 2023

Description:
There are some key areas of improvement to streamline the onboarding process for new contributors in the README file:

  1. Instructions on setting up MongoDB, either with a regular installation or with MongoDB Atlas.
  2. Guidance on how to populate initial data into the MongoDB database using provided endpoints.

Tasks:

  • MongoDB Setup Instructions:

    • Add a section under "Prerequisites" or "Getting Started" that guides contributors through the process of setting up MongoDB.
      • Provide instructions for a standard MongoDB setup.
      • Offer an alternative guide for those who wish to use MongoDB Atlas.
      • Ensure contributors understand how to connect their application instance to their MongoDB instance, particularly if using MongoDB Atlas.
  • Data Population via Endpoints:

    • Detail the need for initial data population for the application to function as expected.
    • Provide instructions on how to hit the POST http://localhost:3001/habit/ endpoint (and any other relevant endpoints) to add initial data.
      • Consider adding information about using a tool like Postman.
      • Optionally, provide a JSON sample for what the POST request's body should look like.

Where to Add:
Consider adding the MongoDB setup instructions under a new sub-section in "Getting Started" named "Setting Up MongoDB". The data population instructions might best fit as an extension to the "Running Backend Node JS Application" section.

Notes:
It's crucial to ensure the README remains clear and not too cluttered. All additions should be concise, well-organized, and intuitive for new contributors. If necessary, link out to more detailed guides or documentation instead of overloading the README.

@lugenx lugenx changed the title Initial setup steps documentation for the local application run Update README to Include MongoDB Setup Instructions and Endpoint Data Population Oct 27, 2023
@lugenx
Copy link
Owner

lugenx commented Oct 27, 2023

Thank you for bringing up these @aditya4196, I have edited the issue to make it more descriptive and assigned it to you, please let me know if you have any questions when working on it.

ayoush-kumar added a commit to ayoush-kumar/ecohabit that referenced this issue Apr 23, 2024
ayoush-kumar added a commit to ayoush-kumar/ecohabit that referenced this issue Apr 23, 2024
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

No branches or pull requests

2 participants