LondheShubham153/crispy_credits

Crispy Credits allows restaurants to sell vouchers at a discount to face value

Crispy Credits - Because Who Doesn't Love a Little Extra Crunch and Credit Vouchers?

Report Bug

Request Feature

Built With

Table of Contents

• About the Project

• Getting Started

• Prerequisites

• Installation

• Docker

• Usage

• Roadmap

• Contributing

• License

• Contact

About The Project

Product Screenshot 1	Product Screenshot 2
Product Screenshot 3	Product Screenshot 4

Welcome to Crispy Credits, the app that's turning vouchers into a delicious experience! 🍟

What's the Crunch?

Crispy Credits is your go-to place for creating, munching on, and savoring vouchers that add a sprinkle of joy to your dining adventures. It's not just an app; it's a crispy journey filled with delightful surprises!

Features That Make You Go "Mmm":

• Crispy Voucher Creation: Restaurants, get ready to fry up some tempting vouchers with mouthwatering buy and get amounts!
• Munch-Worthy Voucher Purchase: Customers, indulge in the joy of purchasing vouchers at a discount. Your wallet will thank you!
• Redeem with Flavor: Use your crispy vouchers to pay for meals. Whether it's a full feast or a light snack, we've got you covered.
• Wallet Goodness: Your Crispy Credits don't just disappear – they're stored safely in your wallet for your next crispy craving.

How to Get Your Crispy On:

1. Clone this flavor-packed repository.
2. Sprinkle in the required dependencies (just like your favorite seasoning).
3. Let migrations marinate your database.
4. Fire up the Django development server and savor the crispy goodness!

For an extra dash of fun and detailed instructions, check out the documentation in the repository. Now, go ahead, grab those Crispy Credits, and let the crunch begin! 🌮✨

Getting Started

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

Prerequisites

• python

python  --version

Installation

1. Clone the repo

https://github.com/LondheShubham153/crispy_credits.git

cd  crispy_credits

2. Activate Virtual Environment

python  -m  venv

venv  source  venv/bin/activate

3. Install python packages

pip  install  -r  requirements.txt

4. Create a .env file

SECRET_KEY = mysecretkey

DEBUG = True

DB_NAME = <database>

DB_USER = <database user>

DB_PASSWORD = <database password>

DJANGO_SUPERUSER_USERNAME = <django super user>

DJANGO_SUPERUSER_EMAIL = <django admin email>

DJANGO_SUPERUSER_PASSWORD = <django super user password>

5. Start Postgres Server

sudo service postgres start

6. Run the migrations

python manage.py makemigrations

python manage.py migrate

7. Test the application

python manage.py test

8. Run the application

python manage.py runserver

Docker

1. Run using Docker Compose

docker-compose  up  -d

2. Stop the application

docker-compose  down

Usage

on your browser, you can access Swagger UI

http://localhost:8000/swagger/

For more examples, please refer to the Documentation

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

Shubham Londhe - shubhamlondhe1996 - My LinkedIn

Project Link: https://github.com/LondheShubham153/crispy_credits