From 343016ba4185a23bc69faf9d9ced8ebbbf33cb8c Mon Sep 17 00:00:00 2001 From: Nishant Sapkota Date: Fri, 16 Sep 2022 15:40:53 +0545 Subject: [PATCH] feat: add README.md --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..139e565 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ + +# Character Certificate Management System + +A Character Certificate Management System written in Django Framework that helps in generating and storing of Character Certificates for any educational institution. + + + + + + +## Features + +- Dynamic certificate generation +- Configurable options including Institute Name, Logo, etc. +- User friendly and easy to use + + + + +## Installation + +### Installation of the Project with Poetry + +```bash + poetry shell + poetry install + python manage.py makemigrations + python manage.py migrate + python manage.py runserver +``` + +### Installation without Poetry + +```bash + pip install -r requirements.txt + python manage.py makemigrations + python manage.py migrate + python manage.py runserver +``` + +## License + +BSD-2-Clause-License +