gabrielrigon / news_api

A basic API sample project to demonstrate the implementation of Express framework.

News API

A basic API sample project

The objective of this project is to demonstrate a basic implementation of API using Express.

Dependencies

• Node 8.12.0
• Yarn 1.10.1

Running this project (development)

1. Clone this repo on your environment path.
2. Install the dependencies running the following command:

  $ yarn

3. Copy the config.json.sample file (localized on config folder), rename to config.json, and configure with your preferences.
4. Start the project running the following command:

  $ yarn dev

5. The API will be listening on the port that you was defined in the config.json file.

To-do

• Improve external requests handler
• Add authentication