oilshit / oilprice-api

Node.js based API for getting oil and gas prices based on oilprice.com

oilprice-api

Live Preview | Project Overview | Setup Requirements | Project Setup | Project Implementation

Live Preview

This project is live on https://oilprice-api.herokuapp.com. Documentation is available on https://oilprice-api.herokuapp.com/docs.

Project Overview

This project displays basic API to get oil and gas prices based on oilprice.com.

Setup Requirements

• Node.js (you can download it here)

Project Setup

Using Terminal (Linux and MacOS) or WSL console (Windows), you can clone this repository by

git clone https://github.com/oilshit/oilprice-api.git
cd oilprice-api

Assuming Node.js installation has been done, you can install project dependencies by

npm install

or

yarn

After installing dependencies, you can start the server by

npm run dev

or

yarn run dev

This will starts localhost server in http://localhost:3000 (port 3000). You can access the API for the first testing by typing http://localhost:3000 in your browser. The documentation of API can be accessed in http://localhost:3000/docs.

Project Implementation

This project has been implemented on following stuffs:

• Extracting oil and gas price data into CSV file (oilprice-extract)
• more coming soon...