linkr-API

About

This is and API for linkr app, an social media for links share.

Technologies

The following tools and frameworks were used in the construction of the project:

How to run

  1. Clone this repository

  2. Install dependencies

npm install
  1. Create a PostgreSQL database

  2. On the linkr-backend folder, import the dump

sudo -u postgres psql DATABASE_NAME < dump.sql
  1. Create an .env file following the .env.example variables

  2. Run the back-end with

npm run start
  1. Follow the isntructions to run the front-end on this link

  2. You also can access the api in http://localhost:PORT (.env PORT)

Developers