Skip to content

Commit 92eccff

Browse files
authored
Create README.md
1 parent aee150a commit 92eccff

File tree

1 file changed

+97
-0
lines changed

1 file changed

+97
-0
lines changed

README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
### README
2+
3+
# University Course Scheduling App
4+
5+
This application is developed using C# and ASP.NET Core to help manage university course schedules. The app allows users to define courses, their prerequisites, and instructors along with their available times. Based on this data, the app generates a weekly schedule.
6+
7+
## Features
8+
9+
- Define courses and their prerequisites.
10+
- Manage instructor information and their availability.
11+
- Generate weekly course schedules automatically.
12+
- User-friendly interface for easy management of data.
13+
14+
## Requirements
15+
16+
- .NET Core SDK 6.0 or higher
17+
- SQL Server or any compatible database
18+
- Visual Studio 2022 (optional but recommended for development)
19+
20+
## Installation
21+
22+
1. **Clone the repository:**
23+
24+
```bash
25+
git clone https://github.com/yourusername/university-course-scheduling-app.git
26+
```
27+
28+
2. **Navigate to the project directory:**
29+
30+
```bash
31+
cd university-course-scheduling-app
32+
```
33+
34+
3. **Restore dependencies:**
35+
36+
```bash
37+
dotnet restore
38+
```
39+
40+
4. **Update database connection string:**
41+
42+
Open `appsettings.json` and update the `ConnectionStrings` section with your database information.
43+
44+
```json
45+
"ConnectionStrings": {
46+
"DefaultConnection": "Server=your_server;Database=your_database;User Id=your_user;Password=your_password;"
47+
}
48+
```
49+
50+
5. **Apply migrations and update the database:**
51+
52+
```bash
53+
dotnet ef database update
54+
```
55+
56+
6. **Run the application:**
57+
58+
```bash
59+
dotnet run
60+
```
61+
62+
The application should now be running at `https://localhost:5001` or `http://localhost:5000`.
63+
64+
## Usage
65+
66+
1. **Define Courses and Prerequisites:**
67+
- Navigate to the "Courses" section.
68+
- Add new courses and specify their prerequisites if any.
69+
70+
2. **Manage Instructors and Availability:**
71+
- Navigate to the "Instructors" section.
72+
- Add new instructors and specify their available times.
73+
74+
3. **Generate Weekly Schedule:**
75+
- Go to the "Generate Schedule" section.
76+
- Click on "Generate" to create a weekly schedule based on the provided data.
77+
78+
## Contributing
79+
80+
If you would like to contribute to the project, please follow these steps:
81+
82+
1. Fork the repository.
83+
2. Create a new feature branch.
84+
3. Make your changes and commit them.
85+
4. Push your branch and create a pull request.
86+
87+
## License
88+
89+
This project is licensed under the MIT License. See the `LICENSE` file for more details.
90+
91+
## Contact
92+
93+
If you have any questions or feedback, please feel free to reach out at [devotalk@gmail.com](mailto:devotalk@gmail.com).
94+
95+
---
96+
97+
Please let me know if you need any additional information or if there are specific details you'd like to include.

0 commit comments

Comments
 (0)