You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description:
There are some key areas of improvement to streamline the onboarding process for new contributors in the README file:
Instructions on setting up MongoDB, either with a regular installation or with MongoDB Atlas.
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.
The text was updated successfully, but these errors were encountered:
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
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.
Description:
There are some key areas of improvement to streamline the onboarding process for new contributors in the README file:
Tasks:
MongoDB Setup Instructions:
Data Population via Endpoints:
POST http://localhost:3001/habit/
endpoint (and any other relevant endpoints) to add initial data.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.
The text was updated successfully, but these errors were encountered: