Skip to content

Commit

Permalink
README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RohanCyberOps authored Oct 20, 2024
1 parent dd10eee commit 607a2ba
Showing 1 changed file with 51 additions and 26 deletions.
77 changes: 51 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,51 @@

# School Management App
# πŸŽ“ School Management App πŸ“š

Welcome to the **School Management App**! πŸŽ“ This application is designed to help manage student records easily and efficiently. Built with Flask, this app provides a simple interface for adding and viewing students.
Welcome to the **School Management App**! This application is designed to help you manage student records easily and efficiently. Built with **Flask**, this app provides a clean and intuitive interface for adding and viewing students.

## Features
---

## ✨ Features

- **Add Students**: Quickly add new students with their names and grades.
- **View Student List**: Easily view all enrolled students in a clean and user-friendly interface.
- **Responsive Design**: The app is designed to work seamlessly on both desktop and mobile devices.
- **In-memory Database**: For demonstration purposes, student data is stored in memory.
- **πŸ‘¨β€πŸŽ“ Add Students**: Quickly add new students with their names and grades.
- **πŸ“œ View Student List**: Easily view all enrolled students in a user-friendly format.
- **πŸ“± Responsive Design**: Seamlessly works on both desktop and mobile devices.
- **πŸ—ƒοΈ In-memory Database**: For demonstration purposes, student data is stored in memory.

---

## Technologies Used
## βš™οΈ Technologies Used

- **Backend**: Flask (Python)
- **Backend**: [Flask](https://flask.palletsprojects.com/en/2.2.x/) (Python)
- **Frontend**: HTML, CSS
- **Database**: In-memory (for demonstration)

## Installation
---

## πŸš€ Installation

To get started with the School Management App, follow these steps:

### Prerequisites
### πŸ”§ Prerequisites

Make sure you have Python installed on your system. You can download it from [python.org](https://www.python.org/downloads/).
Ensure you have Python installed on your system. You can download it from [python.org](https://www.python.org/downloads/).

### Clone the Repository
### πŸ“₯ Clone the Repository

```bash
git clone https://github.com/chrohangurjar1/school_management_app.git
cd school_management_app
```

### Install Flask
### 🐍 Install Flask

You can install Flask using pip:

```bash
pip install Flask
```

### Run the Application
### πŸƒ Run the Application

Once you have Flask installed, you can start the application:

Expand All @@ -49,26 +55,45 @@ python app.py

Open your web browser and navigate to `http://127.0.0.1:5000` to access the app.

## Usage
---

## πŸ–₯️ Usage

1. **πŸ†• Adding Students**: Click on the "Add Student" link to enter a new student's name and grade.
2. **πŸ‘οΈ Viewing Students**: After adding a student, you will be redirected to the main page, where you can see the list of all students.

1. **Adding Students**: Click on the "Add Student" link to enter a new student's name and grade.
2. **Viewing Students**: After adding a student, you will be redirected to the main page, where you can see the list of all students.
---

## Contribution
## 🀝 Contribution

Contributions are welcome! If you have suggestions for improvements or new features, please create an issue or submit a pull request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/NewFeature`)
3. Commit your changes (`git commit -m 'Add some feature'`)
4. Push to the branch (`git push origin feature/NewFeature`)
5. Open a pull request
### Steps to Contribute:

1. **Fork the repository**.
2. **Create your feature branch**:
```bash
git checkout -b feature/NewFeature
```
3. **Commit your changes**:
```bash
git commit -m 'Add some feature'
```
4. **Push to the branch**:
```bash
git push origin feature/NewFeature
```
5. **Open a pull request**.

## License
---

## πŸ“„ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contact
---

## πŸ“¬ Contact

For any inquiries, please reach out to:

Expand Down

0 comments on commit 607a2ba

Please sign in to comment.