Yearbook

View a Live Demo · Report a Bug · Request a Feature

 

Table of Contents

1. About The Project
   • Project Description
2. Getting Started
   • Installation
   • Development
3. Contributing / Adding features

About the Project

Project Description

1. Backend Framework: Django
2. Front-end Framework: Bootstrap
3. Database used: Sqlite

Getting Started

Installation

1. Fork and Clone

   1. Fork the Yearbook Repository
   2. Clone the repo to your local system.

2. Create a Virtual Environment for the Project

   In Windows

   pip install virtualenv
   virtualenv venv
   venv\Scripts\activate

   In Ubuntu/MacOS

   python -m virtualenv venv
   
   source venv/bin/activate

   If you are using another name for the virtual environment other than venv, then please mention it in .gitignore.

3. Install all the requirements

   pip install -r requirements.txt

Development

4. Checkout to a different branch

   git status
   git pull
   git branch
   git checkout -b <your-branch-here>
   
   

5. Make migrations/ Create db.sqlite3

   python manage.py makemigrations
   python manage.py migrate

6. Create a super user. In Django, if you want to access admin page, you need to create an account with staff status first.

   python manage.py createsuperuser
   

   Then select your username and password. You can bypass a common password for development purposes.

7. Run the server on localhost:

   python manage.py runserver

8. Make the changes and send a PR, referencing the changes.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change in the project.