RuppeeRitzz

RuppeeRitzz is a Django-based web application designed to manage and facilitate various functionalities related to financial transactions, accounts, and user management.

---

Table of Contents

• Features
• Setup Instructions
  • 1. Clone the Repository
  • 2. Create a Virtual Environment
  • 3. Activate the Virtual Environment
  • 4. Install Dependencies
  • 5. Apply Database Migrations
  • 6. Create a Superuser
  • 7. Run the Development Server
  • Access the Admin Panel
• Technologies Used
• Contributing
• License

---

Features

• User Authentication: Sign up, log in, and manage accounts securely.
• Transaction Management: Track and manage financial transactions effortlessly.
• Admin Panel: User-friendly Django admin interface for managing users, transactions, and other data.
• Customizable UI: Modern, intuitive design powered by Jazzmin.

---

Setup Instructions

Follow these steps to set up the application on your local system:

1. Clone the Repository

Clone the repository to your local machine using the following command:

git clone https://github.com/shivnandk/RuppeeRitzz.git
cd RuppeeRitzz

2. Create a Virtual Environment

Create a virtual environment to isolate dependencies (recommended).

On Windows:

python -m venv env

On macOS/Linux:

python3 -m venv env

3. Activate the Virtual Environment

Activate the virtual environment you just created.

On Windows:

.\env\Scripts\activate

On macOS/Linux:

source env/bin/activate

4. Install Dependencies

Install the required Python packages listed in the requirements.txt file:

pip install -r requirements.txt

5. Apply Database Migrations

Apply migrations to set up the database schema:

python manage.py migrate

6. Create a Superuser

Set up a superuser account to access the admin panel:

python manage.py createsuperuser

Follow the prompts to provide the username, email, and password.

7. Run the Development Server

Start the Django development server:

python manage.py runserver

The application will be accessible at:
http://127.0.0.1:8000/

Access the Admin Panel

Visit the admin panel at:
http://127.0.0.1:8000/admin/
Log in using the superuser credentials you created.

---

Technologies Used

• Django: High-level Python web framework.
• Django Jazzmin: Modern, responsive admin interface.
• Django Import-Export: Seamless import/export functionality for data.
• Pillow: Python Imaging Library for handling image files.
• ShortUUID: Library for generating short, unique identifiers.

---

Contributing

We welcome contributions to improve RuppeeRitzz! Here's how you can contribute:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or fix:

   git checkout -b feature-name

3. Make your changes and commit them:

   git commit -am 'Add new feature'

4. Push your branch to GitHub:

   git push origin feature-name

5. Open a Pull Request on the main repository.

---

License

This project is licensed under the MIT License.

Feel free to star ⭐ the repository if you find this project useful!