kiriaze/mern-todo

MernDo - A simple project management app, with user accounts, projects, teams, and task management built ontop of the MERN stack. Alt names: Petal, Kava...

MERNDO

A todo/task/project management app built with the MERN stack, with user accounts / authentication, teams, projects and deployment to Heroku.

Requirements

• MongoDb/Atlas
• Express
• React.js
• Node.js
• Heroku
• Postman (Recommended)

Installation Steps

1. Once cloned, run npm run setup from root.
2. Subsequently, npm run dev from root for local development.

Build for Production

cd client
npm run build

Test production before deployment

• NODE_ENV=production node server.js
• Open browser to http://localhost:5000/

---

Notes

💥 To connect to Atlas/Cloud.mongodb.com

• Make a copy of config/default.example.json to config/default.json with your cloud.mongo/atlas values to work locally in test. For production, create a config/production.json file respectively and make sure to ignore this file.

🚀 To deploy to Heroku:

• Create a Heroku account.
• Install heroku cli via their installer (link to heroku) or homebrew.
• Log into your heroku account with heroku login.
• Create the application on heroku with heroku create.
• And subsquently push to heroku with git push heroku master.

Todo's

• Add a ./Merndo.postman_collection.json to rapidly setup the endpoints.
• Add a mailer via Nodemailer or service like mailgun.
• Add testing with mocha/chai for API endpoints.
• Integrate dotenv to replace config/* values.
• Currently this project encompasses both the api and the frontend, and deploys all of it to heroku; consider abstracting the two into their own housing.

---

License