Lee's News - Back End API 🗞

Portfolio Project - Back End

---

Built by: Lee Kirkham (2022 & 2023)

---

Back-End

• Back-end - Hosted version Link: https://lee-be-nc-news.onrender.com/api
• Back-End - Git-Hub Repo Link: https://github.com/leekli/nc-news-backend

Front-End (For this Back-End API)

• Front-End - Hosted version Link: https://fe-nc-news-app.netlify.app/
• Front-End - Git-Hub Repo Link: https://github.com/leekli/fe-nc-news

---

Description

A 'News API' built with Node.js, an Express.js server and a PostgreSQL database.

All endpoints can be found in the endpoints.json file or going to https://lee-be-nc-news.onrender.com/api which lists all endpoints which can be interacted with.

There is a front-end app available for this API, which will allow you to interact with it, available at: https://fe-nc-news-app.netlify.app/

---

Setup Instructions

Installation requirements:

• Node.js 17.x
• Postgres 14.x

Cloning the repositry:

• In your teminal CLI:

$ git clone https://github.com/leekli/nc-news-backend.git
$ cd nc-news

Installing dependencies:

• Required dependencies will be pulled from the package.json file. In your teminal CLI:

$ npm install

Environment setup:

• Once the repo has been cloned, you will need to create two .env files in the root folder: with the .env.test and .env.development file names in the root directory.

• In each of these corresponding .env files you will need to add PGDATABASE=<database_name_here> to each file, pointing to the relevant database:

  .env.development database is nc_news

  .env.test database is nc_news_test

Database set-up and seeding:

• Before using or testing the application, you will need to set the database up, and then seed it with the data:

$ npm run setup-dbs
$ npm run seed

Testing

• Jest and Supertest is the framework used to test this application.

• To run tests:

$ npm test

Docker

• This repo can be ran in a Docker container, a compose.yaml & Dockerfile are included in the root folder. Run the following command:

$ docker compose up

---

Application dependencies:

• npm 8.x
• express 4.x
• pg 8.x
• pg-format 1.x
• dotenv 14.x
• nodemon 2.x

Developer only dependencies:

• jest 27.x
• jest-sorted 1.x
• supertest 6.x