NancyBot

Congressional Security Tracking API
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

This is an API which provides information about congressional positions in the securities market.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Local

  python manage.py runserver

• Dev-Server

  docker-compose up -d --build

Installation

1. Clone the repo

   git clone https://github.com/mooreman11/nancybot.git

2. Create Virtual Environment

   python3 -m venv venv

3. Install Dependancies

   pip install -r requirements.txt

4. Migrate data to DB

   python manage.py migrate

(back to top)

Roadmap

• Congressional Tracking
• Commercializing the API
• Frontend
  • General Dashboard
  • API Key Generator

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Squash Commits (git reset --soft origin/master)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Noah K. Moore - @noahkmoore - [email protected]

Project Link: https://github.com/mooreman11/nancybot

(back to top)