Skip to content

rbsrafa/reddit-app

Repository files navigation

Reddit Basic

Description

A basic copy of the website Reddit for a college assignment. In this project we were instructed to build a REST API using Nodejs and Typescript and Postgres as the database. We should also be able to run a Unit and Integration Test using Chai, Mocha and Supertest libraries. I have also used the Inversify framework to implement IOC (Inversion of Control) and Dependency Injection in this project.

The frontend is built with React and is being served on http://localhost:3001

Check the online version on Heroku Platform

rbs-reddit-app.herokuapp.com

Requirements

  • Nodejs
  • NPM (Node Package Manager)

How to run this project?

  1. Clone this repository to your machine with the command - $ git clone https://github.com/rbsrafa/reddit-basic.git.
  2. In the project's root directory /reddit type the command - $ npm install
  3. Fill the environment variables on file .env
  4. After NPM installs all dependencies type - $ npm start