felipegalvao / medium-comment-system

A Medium like comment system (select / mark text and then comment), using a NodeJS REST Api for the server and React for the client

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Medium like Comment System

Objective: "Build a medium.com style commenting / notes system using a REST API"

Rest API

For the REST API, I used NodeJS with Express and Mongoose. For the database, I used mLab (https://mlab.com/welcome/), a Database-as-a-service for MongoDB.

Client

For the Client, I used React, webpack, Babel, axios for the requests, Bootstrap for styling, Sass and webpack-dev-server. For tests, I used Jest and Enzyme.

Installation Instructions

  • Clone this repo
  • Enter in the root directory of the project
  • Run "npm install"
  • Enter the client folder with "cd client"
  • Run "npm install"
  • You must also set the environment variables MLABUSER and MLABPASSWORD to, respectively, "test-user" and "9nL@*ZHzd$ar/W,y", or you can hardcode these values on the "db.js" file, on the root folder of the project, so that the app can make the connection with mLab's database. If you are using Ubuntu, you can put the variables on .bashrc
  • Go back to the root directory of the project and run "npm start"

About

A Medium like comment system (select / mark text and then comment), using a NodeJS REST Api for the server and React for the client


Languages

Language:JavaScript 99.9%Language:CSS 0.1%Language:HTML 0.1%