LockerProtection

LockerProtection is a web application built using Django, HTML, and CSS. It allows users to protect their lockers by setting up personalized access codes.

Table of Contents

• Features
• Technologies
• Prerequisites
• Installation
• Usage
• Contributing
• License

Features

• User registration and login
• Locker management
• Access code setup
• Dashboard with locker status

Technologies

• Frontend: HTML, CSS
• Backend: Django, Django REST Framework, CORS
• Database: SQLite (default, can be changed)
• Other: Docker (optional for containerization)

Prerequisites

• Python (3.8 or above)
• Git
• (Optional) Docker and Docker Compose

Installation

1. Clone the repository:

   • git clone https://github.com/CodeQuillCrafts/Locker-Protection

2. Install dependencies:

   • pip install -r requirements.txt

3. Create a virtual environment

   • python -m venv ./env
   • cd env/scripts
   • activate

4. Add the .env file in the root directory

   • SECRET_KEY=SECRET_KEY
   • DEBUG=True
   • ALLOWED_HOSTS=localhost,127.0.0.1

5. Set up your database:

   • python manage.py makemigrations
   • python manage.py migrate

6. Create a superuser:

   • python manage.py createsuperuser

7. Run the development server:

   • python manage.py runserver

8. Access the application at http://localhost:8000/

Usage

1. Register an account.
2. Log in and add your lockers.
3. Set up access codes for each locker.
4. Monitor locker status on the dashboard.

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/your-feature-name).
5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

---

This README provides a comprehensive guide to setting up and running the Quotes Application locally. If you encounter any issues or have questions, please feel free to open an issue on the repository.