README.md

Energy Price News API

A project to create a public API that scrapes news sites for anything concerning the changes in energy prices.

This project's secondary aim is to help beginners learn how to contribute to open source projects and will be purposely kept as basic as possible.

Up to date version hosted at: RapidAPI Hub

Original Idea

This project was first thought up after watching this video by Ania Kubów, so many thanks to her for the inspiration. Be sure to check the channel out for more easy to follow tutorials!

Planned Features

• Links to articles
• End points for specific sources
• Thorough documentation
• An open and inviting issue-board to encourage discussion of future features

Language & Prerequisites

• Javascript primarily, therefore:
  • Node.js
  • NPM
• A browser extension for viewing JSON is helpful like JSON Formatter

Installation

• Fork this repo and then clone your fork to an empty local directory using SSH
• run:

npm install

• Now the basis of the project is here and can already be viewed by running:

npm run dev

• You may view the various endpoints by opening localhost:8000 in your browser and appending the desired route
  • e.g. localhost:8000/api/news

Contribution

The aim for this project it to be very easy to access, so please have a look through the issues listed to see if any suit your current or desired skills. The maintainers of the project will try to keep it all as up-to-date as possible.

I would like to encourage contributions of any kind to this project:

• Issues:
  • Suggestions on how to do something
  • Problems/bugs found in the code
  • Ideas for features
  • Discussion around best practices so that others can learn from your experience/knowledge
• Pull Requests
  • Should you have a feature you'd like to share already coded, please submit a detailed pull request
  • A preferred PR format is TBC
• Documentation
  • Spellchecking and typo corrections are ALWAYS welcome 😂, seriously, I hate typos but make them frequently!
  • Further detail. If you feel something needs to be expanded on, please do so and submit your PR.
  • Wiki: If we get to a point that a wiki would be helpful, please open an issue/discussion with your suggestions
  • As the project grows, this README.md file will need updating, so add to it where you see fit.
• Share what you do
  • In order to encourage others to join in, feel free to share what you have done on your social media/websites
  • If you know someone that has done something similar, please show them this project as their input would be greatly appreciated

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Soshun Esaki 💻	nulad 💻 🤔	takanome_dev 💻 🤔 📖 🚇 🔧 🔬 👀 💬	AyushiN 💻	Yoshemith Castellanos Irribarren 💻 🤔 🚇 🖋 🎨	dbsaw 💻 🤔	Diego Cordoba 💻
Anu 📖	James Neff 💻	Jon Rutter 💻	Roberto 💻 🤔	Elmir Ismayilov 💻	Ramón Soria 💻	alesbe 💻 🐛
kvaithin 💻	apurva-hub 💻	cfkim 💻 🤔	Ghada 💻	Klesta Luli 💻	Jayavardhan 💻	Dalu46 💻
Ian 💻

This project follows the all-contributors specification. Contributions of any kind welcome!