A simple yet powerful API developed to aid pet adoption organizations. It's designed using Django and Django Rest Framework.
This project is built with the following technologies:
- Python 3.x
- Django
- Django Rest Framework
Follow these instructions to get this project up and running on your local machine.
Ensure you have Python 3.x installed on your machine. You can download it here.
- Create and activate a virtual enviroment:
$ python -m venv env
$ source env/bin/activate
- Install dependencies:
$ pip install -r requirements.txt
- Create superuser for admin access:
$ cd src
$ python manage.py createsuperuser --email [email protected] --username admin
- Run application:
$ python -m manage.py runserver
- Admin Section
- Access the Django admin at
127.0.0.1:8000/admin/
- API Endpoints
-
List all pets or create a new pet:
127.0.0.1:8000/api/v1/pets -
Access, update, or delete a specific pet:
127.0.0.1:8000/api/v1/pets/<id>
- Automated Tests
- Run the automated tests using:
$ python manage.py test
Happy coding! 🐾