Welcome to NewsAPI! This is a RESTful API designed to provide developers access to articles, topics, comments and user data from various news sources.
See /api for a detailed list of each endpoint.
You can access the hosted app here.
To get started with this project, follow these instructions:
- Clone the repository:
git clone https://github.com/rmachaal/News-API-Project.git
- Install project dependencies:
npm install
- Seed the local database:
npm run seed
- Execute tests:
npm run test
To set up the environment, create two .env files: .env.test and .env.development.
In each file add PGDATABASE=, with the correct database name for that environment.
This project requires node.js version 10 or higher and PostgreSQL version 8.11.5 or higher (within 8.x series).