Reactor API

A REST API written in Django detailing US nuclear reactor data and status reports.

Explanation

This project uses Django REST to create an API that exposes endpoints for data gathered from the nuclear reactor power status .txt file provided, as well as other data gathered from https://www.nrc.gov/.

Follow the steps below to get started:

Project setup

• Git clone this repo to your PC:

  git clone git@github.com:ellis3684/reactor-api-sesco.git

• CD into the project directory

  cd reactor-api-sesco

• Create a virtual environment:

  python -m venv venv

• Activate virtual environment:

  source venv/bin/activate

• Install dependencies:

  pip install -r requirements.txt

Database setup

• Run Django migrations:

  python manage.py migrate

• Import data from .csv and .xlsx files into database (this will take up to a minute):

  python manage.py importdata

Start the server and navigate endpoints

• Start the server with the below command:

  python manage.py runserver

• Access below url for the endpoint documentation:

  http://127.0.0.1:8000/docs/

• Choose an endpoint in the documentation to navigate to.