TEMPLE DATABASE MANAGEMENT SYSTEM

Table of Contents

1. • Installation
   • Development
2. Contributing / Adding Features
3. License

1. Backend Framework: Flask

2. Front-end Framework: MDBootstrap

INSTALLATION

1. Fork and Clone

   1. Fork the Repo
   2. Clone the repo to your computer

2. Create a Virtual Environment for the Project

   In Windows

   python -m venv venv
   
   venv\Scripts\activate

   In Ubuntu/MacOS

   python -m virtualenv venv
   
   source venv/bin/activate

   If you are giving a different name then venv, then please mention it in .gitigonre first

3. Install all the requirements

   pip install -r requirements.txt

4. Run server

   python app.py 

5. Do the Development and send me a PR referencing the issue.

DEVELOPMENT

   git checkout develop-<username>
   //Create the changes and then commit
   git add <filename>
   git commit -m "<Message here>"

From your master branch or your main branch that you are working on, give a PR to our develop branch.

Developers should create a folder /media and put an image named default.jpg to avoid errors in creating superuser.

!IMPORTANT: Don't give a PR to the master branch We only accept PR's to develop branch.

CONTRIBUTIONS

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. While sending the PR please mention the issue in the Comment.

LICENSE

Apache License 2.0

THANK YOU