Appended the documentation to Readme.md#257
Conversation
|
I have added few more ideas to the ideas.md file |
lugenx
left a comment
lugenx
left a comment
There was a problem hiding this comment.
hi @aditya4196 , this is good thank you, i have suggested some improvements. please check the comments.
README.md
Outdated
| - Open the cloned folder in VS Code. Open the terminal and make sure its pointing to the root of the cloned project. | ||
|
|
||
|
|
||
| - Database creation |
There was a problem hiding this comment.
when reading from the start of the "how to run" section, all the sentences starts with verbs (Clone the repo..., Open the cloned folder...), it feels like this should be like this: "Create a database for development use"
README.md
Outdated
| - Create a cluster (by default is Cluster0 which can be used) | ||
| - Once the cluster is up, you need to click on the 'Connect' tab and follow the drivers section to retrieve the mongodb connection url and save it for the next steps | ||
|
|
||
| <br> |
README.md
Outdated
|
|
||
| <br> | ||
|
|
||
| - Running Backend Node JS Application: |
There was a problem hiding this comment.
can we please change this old text too?
"Run the backend NodeJS application:"
README.md
Outdated
|
|
||
| - Change the directory to server folder using terminal command: `cd server` | ||
| - At the root of the server directory, create an .env file and copy the content from .env.example into the new .env file. | ||
| - update the 'MONGODB_URL' property in the .env file with the mongodb connection url saved during Database creation |
There was a problem hiding this comment.
capitalize the first later: "Update the..."
README.md
Outdated
| - Insert habit dummy data: | ||
|
|
||
| - Go back to the MongoDB website to your project you created. | ||
| - You will see a 'test' collection populated |
There was a problem hiding this comment.
this part is unclear for me, how "test" collection populated.
|
Sure, i will make changes and commit again |
|
I have pushed the requested changes |
|
Deleted the documentation.md file and just corrected one small change in the Readme.md |
There was a problem hiding this comment.
I think we can remove this file since we are using the same text in the readme.
| answerOptions: ["3boxes", "4boxes"], | ||
| __v:0 | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Just paid attention to the content here, I know this is just test data, but I think it would be nice to have the data closer to something we would really use in real. For example, having Uber or Lyft as ridesharing is not something our habit tracker shoud care about. See the below data as example:
{
"category": "Recycle",
"description": "Reduce the amount of waste by using reusable bags!",
"question": "Which one of these did you use today?",
"answerOptions": ["Reusable bag", "Plastic bag", "Both", "None"]
}
{
"category": "Commute",
"description": "Carpool with coworker or friends",
"question": "How did you commute to work today?",
"answerOptions": ["Drived", "Carpooled", "Bike", "Public Transport"]
}
{
"category": "Recycle",
"description": "Separate your recycble materials",
"question": "Did you separate your recycble materials today?",
"answerOptions": ["Yes", "No"]
}
changed the test data
|
I updated the test data. Can you review it? |
lugenx
left a comment
lugenx
left a comment
There was a problem hiding this comment.
Hi @aditya4196, thanks for your work on this; it looks good. I noticed the documentation.md file is back in the PR. since you've removed it before, could you please ensure it's not included again? Thank you!
There was a problem hiding this comment.
please remove Documentation.md file.
|
@lugenx, I was out of touch for last couple of months. Anything else to do with this as it is not yet closed? |
Please check the comments above. |
2 participants
Issue #255