jlblumberg / mern-messenger Goto Github PK

Outline | Installation Instructions | Tech stack | Example use | Future work

Use the MERN stack to build a message board app.

• Clone this repo to your local machine and cd into it.
• Download Node.js if you don't have it already - instructions here.
• Run cd backend && npm install and cd ../frontend && npm install to get the project's dependencies.

In order to persist messages across reloads, the app makes use of MongoDB. In order to use this in the dev environment, you must have it installed locally. Instructions on how to do this here.

Development:

• Start the MongoDB connection with brew services run mongodb-community.
• Run the frontend server in one terminal window, from the frontend directory, with the command npm start. Run the backend server in another terminal window, from the backend directory, with npm start.
• Visit http://localhost:3000 to use the site.

Production:

• There isn't a production version at the moment. See future work section below.

• Tests can be run against both the frontend and the backend code. In either directory, run npm test.

Front-end:

• HTML & CSS
• React

Back-end:

• Node.js
• Express
• MongoDB

Testing:

• Mocha, Chai for backend
• Jest, Enzyme for frontend
• Supertest for testing the API connections

You can see a screenshot of the site in use below. You can add posts, and update or delete existing posts.

On a revisit of the project, I would like to add the following:

• CI & CD
• On the CD point, production deployment
• Authentication