barionleg / adv-nuclear-reactor-api

An API containing web scraped data of advanced nuclear reactor designs

Advanced Nuclear Reactors API

An API containing web scraped data of advanced nuclear reactor designs.
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

![Product Name Screen Shot][product-screenshot]

As an energy wonk, I've notice how difficult it is find up to date information on advanced nuclear reactor designs. This project aims to aggregate information on all advanced nuclear reactor technologies that exist around the world.

It is a work in progress and the data is constantly evolving as I enhance my web scraper script and add new sources.

How It's Made

Tech used:

• Node.js
• Express
• Puppeteer
• Cheerio

The data for this API project was obtained by creating a custom web scraper script using Cheerio. At the moment, the scraper pulls data from the International Atomic Energy Agency but the scraper will be enhanced to recieve multiple url inputs (if you have any quality sources, please let me know!).

Getting Started

This API can be accessed via https://adv-nuclear-api.herokuapp.com/ or as a local copy. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/github_username/repo_name.git

2. Install NPM packages

   npm install

Usage

1. Run server

    node server.js
    npm run dev  // nodemon command

2. Navigate to server

   `localhost:8000`

Roadmap

• Client Side API interaction
• Web scraper enhancements (new & multiple sources scraping)
• Feature to allow reactor developers to add reactor data

See the open issues for a full list of proposed features (and known issues).

Lessons Learned:

My biggest take away is how powerful JavaScript is as a language. Prior to this project, I assumed that I would always need Python to scrape any web content. After finding Cheerio, scraping content became--dare I say--a much less daunting experience due to how intuitive and easy to use Cheerio is.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - @devdanielk - [email protected]

Project Link: https://github.com/danjkim21/adv-nuclear-reactor-api

Live Link: https://adv-nuclear-api.herokuapp.com/

Acknowledgments

• IAEA ARIS Database
• WIKI Source

(back to top)