Project Muttley is intended for people who wish to write their own Front End and have an intuitive API that deals with all the heavy lifting. It is built using Django Rest Framework and is a working progress.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
git clonethe repo into your own directory and wire up the database how you see fit.- create your virtual environment either with pipenv or prebuilt inside Pycharm
./manage.py makemigrations./manage.py migrate./manage.py runserver
See deployment for notes on how to deploy the project on a live system.
The unit tests are currently not yet written and are a current epic.
Will be explained here
Additional notes about how to deploy this on a live system coming soon
- Django - The main framework used
- Django Rest Frameowrk - The API Stuff
- ROME - Used to generate RSS Feeds (to be added)
It is my intention for peeps to contribute and for details on our code of conduct, and the process for submitting pull requests to us can be found out later.
If you would like to contribute great, use branches!
Still very much early days 0.01
- Spencer Barriball - Initial work - 5pence
This project is licensed under the GNU GPLv3 License - see the LICENSE.md file for details
- Dan Bader - From RealPython
- Michael Kennedy - Talk Python To Me