Readable Project

Readable is a single paged web app which manages posts and comments.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

On Ubuntu:

sudo apt-get install git
sudo apt-get install nodejs

Clone the git repository and install all project dependencies with npm install.

git clone https://github.com/stefanadelbert/readable
npm install

cd readable/api-server
npm install

cd readable/frontend
npm install

In a terminal, change to the readable/api-server directory and start the backend server with node server.js.

cd readable/api-server
node server.js

Navigate to the documentation page served by the backend server at http://localhost:3001 to confirm that it is running.

In a terminal, change to the readable/frontend directory and start the development server with npm start.

cd readable/frontend
npm start

Navigate to the page served by the development server at http://localhost:3000.

To run the tests,

npm test