imprashant98 / school_project Goto Github PK

#Dechentsemo Central School Website

This project is a Django-based website for Dechentsemo Central School, featuring a dashboard, calendar, to-do list, pie charts, and attendance management.

**Table of Contents**

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

**Features**

- Dashboard displaying various school activities and statistics.
- Calendar for managing and viewing school events.
- To-do list for managing tasks.
- Pie charts showing the distribution of students and teachers.
- Attendance management system.

**Installation**

Follow these steps to set up the project locally:

###1. Clone the Repository

```bash
git clone https://github.com/imprashant98/school_project.git
cd school_project
```

# Create a virtual environment
python -m venv venv

# Activate the virtual environment (Windows)
venv\Scripts\activate

# Activate the virtual environment (macOS/Linux)
source venv/bin/activate

Install the required packages using pip:

pip install -r requirements.txt

Run the following commands to apply migrations and set up the database:

python manage.py makemigrations
python manage.py migrate

Create a superuser to access the Django admin interface:

python manage.py createsuperuser

Follow the prompts to set up your superuser account.

Start the development server:

python manage.py runserver

Open your web browser and navigate to http://127.0.0.1:8000/ to see the website.

Navigate to http://127.0.0.1:8000/admin and log in with the superuser credentials you created to manage the site.

To add events, navigate to http://127.0.0.1:8000/add_event/ and fill out the event form.

To edit attendance, navigate to http://127.0.0.1:8000/edit_attendance/ and use the editable table to update attendance records.

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes.
4. Push your branch to your fork.
5. Create a pull request with a detailed description of your changes.

This project is licensed under the MIT License. See the LICENSE file for more details.

For any questions or suggestions, please contact us at [email protected] and [email protected].

### Explanation

- **Title and Description**: Provide a brief overview of the project.
- **Table of Contents**: List the main sections of the README.
- **Features**: Highlight key features of the project.
- **Installation**: Detailed steps to set up the project locally, including cloning the repository, setting up a virtual environment, installing dependencies, applying migrations, creating a superuser, and running the development server.
- **Usage**: Instructions on how to access and use different parts of the website.
- **Contributing**: Guidelines for contributing to the project.
- **License**: Information about the project's license.
- **Contact**: Contact information for further questions or suggestions.