CTORRUBIA - Northcoders News API

Background

CTORRUBIA - Northcoders News API is a node-postgres back-end API for a Reddit-style news website. The intention here was to mimic the building of a real world backend service (such as reddit) which will provide this information to the front end architecture.

The database used was PSQL, and interactions have been carried out using node-postgres.

A live version can be accessed here: https://nc-news-soloproject-be.onrender.com/

If the data is appearing on one line, it can be hard to read. You may find it easier to read by installing a JSON Formatter extension to your browser. I recommend this one for Chrome. In Firefox it should not be a problem.

Written by Cristóbal G. Torrubia. Latest version 1.0.0 (12 May 2023).

This project has been part of the Northcoders bootcamp, 27th March 2023 - 23rd June 2023.

---

Set-up guide

1. Install dependencies

$ npm i
$ npm i -D jest
$ npm i -D jest-sorted

At a minimum, Node.js v19.7.0 and PostgreSQL 14.7 are required. Postgres will be installed with the command above.

2. Set environment variables

Create two .env files, .env.development and .env.test, which should read respectively:

PGDATABASE=nc_news

PGDATABASE=nc_news_test

3. Set-up and seed the databases

$ npm run setup-dbs
$ npm run seed

The databases can now be accessed via psql.

---

Testing

To run the provided test suite:

$ npm t

To run the dev environment:

$ npm run dev

---

Available endpoints

GET /api/

• Retrieves a JSON object of available endpoints in the API

GET /api/topics

• Retrieves a list of topics

GET /api/articles

• Retrieves a list of articles
• Can paginate by means of limit and p (page)

GET /api/articles/:article_id

• Retrieves an individual article, along with the number of comments associated with it

PATCH /api/articles/:article_id

• Increments the article's votes property by the inc_votes property in the request body
• Example request body:

{ inc_votes: 1 }

GET /api/articles/:article_id/comments

• Retrieves a list of comments associated with the given article_id
• Can paginate by means of limit and p (page)

POST /api/articles/:article_id/comments

• Adds a comment to the database, associated with the given article_id
• Example request body:

{ username: "jessjelly", body: "I love this site!" };

DELETE /api/comments/:comment_id

• Deletes the specified comment from the database

GET /api/users

• Retrieves a list of users currently registered to the site.`

GET /api/users/:username

• Retrieves an individual user object
• :username must be valid and exist
• Example response body:

{
	"user": {
		"username": "jessjelly",
		"avatar_url": "https://vignette.wikia.nocookie.net/mrmen/images/4/4f/MR_JELLY_4A.jpg/revision/latest?cb=20180104121141",
		"name": "Jess Jelly"
	}
}

POST /api/article

• Adds an article to the databased
• author and topic must be valid and exist
• Example request body:

            {
				title: 'Test article is my passion',
				topic: 'mitch',
				author: 'butter_bridge',
				body: 'This is a test article. My mere existence is reduced to a test',
				article_img_url:
					'https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700',
			}

• Example response body:

{
      article_id: 13,
      title: 'Test article is my passion',
      topic: 'mitch',
      author: 'butter_bridge',
      body: 'This is a test article. My mere existence is reduced to a test',
      created_at: '2023-05-12T12:31:32.428Z',
      votes: 0,
      article_img_url: 'https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700',
      comment_count: 0
    }

PATCH /api/comments/:comment_id

• Increments the comments's votes property by the inc_votes property in the request body
• Example request body:

{ inc_votes: 1 }

---

Copyright (c) 2023 - Cristóbal Gutiérrez Torrubia