uiReport App (API)

uiReport enables users to report crime incidents within the University of Ibadan

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• Django
• Django REST framework

Getting Started

To get a local copy up and running follow these simple steps.

Installation

$ git clone https://github.com/Toluwalemi/django-API-CrimeReport-System.git
$ cd django-API-CrimeReport-System
$ pipenv install
$ pipenv shell

# Run Migrations
(django-API-CrimeReport-System) $ python manage.py migrate

# Create a Superuser:
(django-API-CrimeReport-System) $ python manage.py createsuperuser

#Confirm everything is working:
(django-API-CrimeReport-System) $ python manage.py runserver

# Load the site at htpp://127.0.0.1:8000
# (check api/url.py for the URL patterns)

Roadmap

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

Contributing

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

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

License

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

Contact

Toluwalemi - @Toluwalemi

Project Link: https://github.com/Toluwalemi/django-API-CrimeReport-System

Acknowledgements

• timmyCoder