NC News API

This is a rest API built using PostgreSQL which provides the data for the frontend NC News app.

Tech Stack:

• PostgreSQL
• node.js
• Express.js - framework
• Jest - test framework
• supertest

How to set up the repo locally

Create two environment files called .env.test and .env.development

1. Set PGDATABASE = nc_news inside .env.development file
2. Set PGDATABASE = nc_news_test inside .env.test file

Install

You would need to run the following command to install all the necessary packages to run the app successfully.

npm install

How to run the app locally

First, set up the DBS

npm run setup-dbs

Then, start seeding the database with the data by running this command

npm run seed

The minimum version of the node required to run this project -

Node.js v21.2.0

The minimum version of Postgres required to run this project

psql (14.10 (Homebrew), server 16.1)

• Link to the hosted version - https://nc-news-1-ukr6.onrender.com/api