Northcoders News API

Link to Hosted Version

Summary

The Northcoders News API is a robust backend server designed to serve data for a news platform. It provides a variety of endpoints allowing users to interact with topics, articles, comments, and users. The API is built with Node.js and Express, using a PostgreSQL database to store and manage data. Users can retrieve information on topics, articles, comments, and users, as well as perform actions such as posting comments, voting on articles, and deleting comments.

Getting Started

1. Clone this repository to your local machine.

   git clone https://github.com/KcalbJ/Nc-news.git

2. Navigate to the project directory.

   cd Nc-news

3. Install dependencies.

   npm install

4. Create the necessary environment files.

   touch .env.test .env.development

5. Open each .env file and add the following:

   PGDATABASE=database_name

   Make sure to replace database_name with the correct database name for the corresponding environment. (see /db/setup.sql for the database names). Double check that these .env files are .gitignored.

6. Seed the local database.

   npm run seed

7. Run tests to ensure everything is set up correctly.

   npm test

8. Start the development server.

   npm start

API Endpoints

• GET /api: Get all endpoints.
• GET /api/topics: Get all topics.
• GET /api/articles/:article_id: Get an article by its ID.
• GET /api/articles: Get all articles.
• GET /api/articles/:topic: Get all articles by topic.
• GET /api/articles/?sort_by=QUERIE&order=asc/desc: Get all articles and sort them by column and order them.
• PATCH /api/articles/:article_id: Update an article's details.
• GET /api/articles/:article_id/comments: Get comments for a specific article.
• POST /api/articles/:article_id/comments: Post a new comment for an article.
• DELETE /api/comments/:comment_id: Delete a comment by its ID.
• PATCH /api/comments/:comment_id: Update a comment's votes.
• GET /api/users: Get all users.
• GET /api/users/:username: Get a user by their username.
• PATCH /api/users/:username: Update a user's votes.

Minimum Requirements

• Node.js version 20.6.1
• PostgreSQL version 14.9