News API
This project consists of a back-end API for a news system similar to Reddit, where users can post articles on different topics. The users can also post comments on the articles. Articles and topics can receive positive and negative votes from users, depending on whether they liked the content or not. The project was created with JavaScript (Node.js) and an Express.js server. The project was done entirely with test-driven development, using Jest and Supertest. The database was implemented with PostgreSQL, and the entire project was modeled following the MVC design pattern.
Setup instructions:
The project uses two different databases for different purposes:
Test database: used during the testing phase. Dev database: used during development phase. Important
You need to create two different .env files to setup the databases as follows: .env.development - Uses the development database, set the variable PGDATABASE to the correct database (PGDATABASE=database_name_here)
.env.test - Uses the test database, set the variable PGDATABASE to the correct database (PGDATABASE=database_name_here)
Please refer to db/setup.sql file for the correct database names, and also to create the databases locally;
To install the databases: - npm run setup-dbs on your terminal.
To seed the databases: - npm run seed
To install the project dependencies: - npm install
To run the project tests: - npm run test
Minimum versions to run the project
Node.js: - ^v21.5.0 ProstgreSQL: - ^8.7.3 API endpoints:
GET /api - returns an object describing all the available endpoints on your API.
GET /api/topics - returns an array of topic objects: Example:
"exampleResponse": { "topics": [{ "slug": "football", "description": "Footie!" }] } POST /api/topics - Post a new topic in the database. Returns the posted topic object.
Required body: { slug: "new topic", description: "New topic description" }
"exampleResponse": { "topic": [ { "slug": "new topic", "description": "New topic description." } ] } GET /api/articles - return an array of articles objects, filtered by the queries if passed any.
Available queries: [topic,sort_by,order,limit,p]
topic: filter by the specified topic.
sort_by: sort by the specified column.
order: order asc or desc.
limit: limit of articles per page.
p: page number from where the system will start selecting articles.
Examples of cals with query: /api/articles?topic=cats
Examples of cals with query: /api/articles?topic=coding&sort_by=title&order=asc
"exampleResponse": { "articles": [ { "article_id": 34, "title": "The Notorious MSG’s Unlikely Formula For Success", "topic": "cooking", "author": "grumpy19", "body": "The 'umami' craze has turned a much-maligned and misunderstood food additive into an object of obsession for the world’s most innovative chefs. But secret ingredient monosodium glutamate’s biggest secret may be that there was never anything wrong with it at all.", "created_at": "2020-11-22T11:13:00.000Z", "votes": 0, "article_img_url": "https://images.pexels.com/photos/2403392/pexels-photo-2403392.jpeg?w=700&h=700", "comment_count": 11 } ] } POST /api/articles - Post a new article in the database, returns the posted article object.
Required Body: { "author": "rogersop", "title": "The new rogersop Article!", "body": "That should be a very interesting article, but I can't think of what to write in here.", "topic": "paper", "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700" }
"exampleResponse": { "article": [ { "article_id": 14, "title": "The new rogersop Article!", "topic": "paper", "author": "rogersop", "body": "That should be a very interesting article, but I can't think of what to write in here.", "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700", "created_at": "2024-04-19T12:09:00.000Z", "votes": 0, "comment_count": 0 }] } GET /api/articles/:article_id - return an array with the object corresponding to the given id
"exampleResponse": { "article": [ { "article_id": 1, "title": "Living in the shadow of a great man", "topic": "mitch", "author": "butter_bridge", "body": "I find this existence challenging", "created_at": "2020-07-09T20:11:00.000Z", "votes": 100, "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700", "comment_count": 11 }] } DELETE /api/articles/:article_id - Delete a given article and it's comments from the database. Return status 204 on success.
GET /api/articles/:article_id/comments - return an array of comments for a given article
Available queries: limit and p.
limit - limit the results by the amount specified. I.e: limit=5
p - starting p from where the system will start fetching comments. I.e: p=2
Example of call with queries: /api/articles/1/comments?limit=5&p=2
"exampleResponse": { "comments": [ { "comment_id": "6", "votes": "1", "created_at": "2020-10-11T16:23:00.000Z", "author": "butter_bridge", "body": "This is a bad article name", "article_id": "6" }] } POST /api/articles/:article_id/comments - Adds a comment to the given article, returns the added comment.
Required Body: { "username": "icellusedkars", "body": "This is the icellusedkars new omment!" }
"exampleResponse": { "comment": [ { "comment_id": "19", "votes": "0", "created_at": "2024-04-16T14:59:56.973Z", "author": "icellusedkars", "body": "This is the icellusedkars new comment!", "article_id": "2" }] } PATCH /api/articles/:article_id - Update the number of votes for a given article by the number passed on the patch body:
Required Body: { inc_votes: 1} Votes was 100, updated by 1 is now 101.
"exampleResponse": { "article": [ { "article_id": "1", "title": "Living in the shadow of a great man", "topic": "mitch", "author": "butter_bridge", "body": "I find this existence challenging", "created_at": "2020-07-09T21:11:00.000Z", "votes": "101", "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700" }] } DELETE /api/comments/:comment_id - Delete the given comment from the databse. Returns status 204 if deleted.
"exampleResponse": {} GET /api/users - Get all the users from the database. Returns an array of user objects.
"exampleResponse": [ { "username": "butter_bridge", "name": "jonny", "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg" }, { "username": "icellusedkars", "name": "sam", "avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4" } ] GET /api/users/:username - Get the user for the given username. Returns an array with the user object.
"exampleResponse": [ { "username": "butter_bridge", "name": "jonny", "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg" } ] PATCH /api/comments/:comment_id - Update the number of votes for a given comment. Returns the updated comment.
Required Body: { inc_votes: 1 }
"exampleResponse": { "comment": [ { "comment_id": "19", "votes": "1", "created_at": "2024-04-16T14:59:56.973Z", "author": "icellusedkars", "body": "This is the icellusedkars new comment!", "article_id": "2" }] }