Overdrive - Flask-React

This is an evolving project that's meant to be a framework that entices new ideas and challenges existing ones. Written in flask and react and contains no real purpose at this time.

Table of contents

• Overdrive - Flask-React
• Table of contents
• Usage
• Installation
• Updating
• Uninstallation
• Contributing
• License

Usage

(Back to top)

Getting started is pretty easy when docker community edition is installed.

Navigate to localhost and enjoy!

Installation

(Back to top)

1. Install docker community edition

2. Clone the repo

   • git clone https://github.com/iamjohnnym/flask-react
   • cd flask-react

3. Build the flask-react project.

   • make build

4. Test the build

   • make test

5. In your favorite browser nagivate to:

   • localhost

Updating

(Back to top)

Want to update to the latest version of flask-react? Nagivate to your project dir and pull the repo down.

cd ~/path/to/flask-react
git pull

Uninstallation

(Back to top)

make down # shut down all docker-compose related services
cd ../ # move down one directory
rm -rf flask-react  # delete project directory

Contributing

(Back to top)

Your contributions are always welcome! Please have a look at the contribution guidelines first.

License

(Back to top)

Apache License, Version 2.0 2018 - Johnny Martin. Please have a look at the LICENSE.md for more details.