Git Product home page Git Product logo

the-source-news-backend's Introduction

the source news

A RESTful news API.

Read articles, browse topics, comment and vote on the latest news

Available actions include:

  • Topics: get all topics, add a topic
  • Articles: post an article in a topic, get all articles for a topic, get all articles
  • Single article: get, vote on, or delete an article
  • Comments: get all comments for an article; post, vote on or delete a comment
  • Users: get all users, add a user
  • All endpoints that serve articles or comments are queriable, allowing chages to sort order, sort criterion, and pagination

See https://the-source-news.herokuapp.com/api for a detailed list of endpoints and how to interact with them.

Getting Started

Prerequisites

  • Node.js
  • PostgreSQL

To run the project locally:

  • Clone the repo and run the command npm install. This will install all the necessary dependencies.
  • See package.json for a list of other commands available, including database migrations and seeding, development mode, and testing.

Running the tests

To run the tests, use the command npm test. This will set up a test database on your machine and run the spec folder using test data.

Deployed Version and Links

View a deployed version of the API here: https://the-source-news.herokuapp.com/api

the source news also has a responsive frontend built with ReactJS.

Frontend on Github: https://github.com/craigweighman/the-source-news-frontend

Frontend deployed version: https://the-source-news.netlify.com/

Built by

Craig Weighman - github.com/craigweighman

Acknowledgments

This project was completed as part of the Northcoders Developer Pathway. Thanks to the tutors at Northcoders for their support and feedback throughout

the-source-news-backend's People

Contributors

anorthernboy avatar nc-paul-rogerson avatar anatdean avatar sssam-c avatar anthonymedina avatar p-copley avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.