Skip to content

Commit ae6c760

Browse files
committed
Add README.md with project overview, structure, installation instructions, usage guidelines, contributing details, and ChatMateServerApp information
1 parent fd478f6 commit ae6c760

File tree

1 file changed

+110
-0
lines changed

1 file changed

+110
-0
lines changed

README.md

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Python Exam Fall 2024 - ICTU
2+
3+
Welcome to the Python Exam Fall 2024 project repository for ICTU. This repository contains all the necessary materials and instructions for the Python exam.
4+
5+
## Table of Contents
6+
7+
- [Introduction](#introduction)
8+
- [Project Structure](#project-structure)
9+
- [Installation](#installation)
10+
- [Usage](#usage)
11+
- [Contributing](#contributing)
12+
- [License](#license)
13+
- [ChatMateServerApp](#chatmateserverapp)
14+
15+
## Introduction
16+
17+
This project is designed to help students prepare for the Python exam in Fall 2024. It includes sample questions, practice exercises, and reference materials.
18+
19+
## Project Structure
20+
21+
The repository is organized as follows:
22+
23+
```
24+
python-exam-fall2024-ictu/
25+
26+
├── src/
27+
│ ├── maths/
28+
│ └── solutions/
29+
30+
├── tests/
31+
32+
├── docs/
33+
34+
├── chat-mate/
35+
│ └── ChatMateServerApp/
36+
37+
└── README.md
38+
```
39+
40+
- `src/`: Contains the source code for exercises and solutions.
41+
- `tests/`: Contains test cases for the exercises.
42+
- `docs/`: Contains documentation and reference materials.
43+
- `chat-mate/ChatMateServerApp/`: Contains the Blazor Server App project that uses a SQLite database.
44+
45+
## Installation
46+
47+
To get started, clone the repository to your local machine:
48+
49+
```bash
50+
git clone https://github.com/rodern/python-exam-fall2024-ictu.git
51+
cd python-exam-fall2024-ictu
52+
```
53+
54+
## Usage
55+
56+
Navigate to the `src/` directory to find the exercises and solutions. You can run the exercises using Python:
57+
58+
```bash
59+
python src/maths/exercise1.py
60+
```
61+
62+
## Contributing
63+
64+
We welcome contributions from the community. If you would like to contribute, please fork the repository and create a pull request with your changes.
65+
66+
## License
67+
68+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
69+
70+
## ChatMateServerApp
71+
72+
The `ChatMateServerApp` is a Blazor Server App included in this repository. It uses a SQLite database and provides various services.
73+
74+
### Project Structure
75+
76+
The `ChatMateServerApp` is organized as follows:
77+
78+
```
79+
chat-mate/ChatMateServerApp/
80+
81+
├── Data/
82+
├── DbModels/
83+
├── DbServices/
84+
├── Pages/
85+
├── Program.cs
86+
├── appsettings.json
87+
└── Startup.cs
88+
```
89+
90+
- `Data/`: Contains data services and context.
91+
- `DbModels/`: Contains database models.
92+
- `DbServices/`: Contains database service interfaces and implementations.
93+
- `Pages/`: Contains Blazor pages.
94+
- `Program.cs`: Main entry point of the application.
95+
- `appsettings.json`: Configuration file.
96+
- `Startup.cs`: Configuration for services and middleware.
97+
98+
### Running the Application
99+
100+
To run the `ChatMateServerApp`, navigate to the project directory and use the following command:
101+
102+
```bash
103+
dotnet run
104+
```
105+
106+
The application will be available at `https://localhost:5001`.
107+
108+
### Database Configuration
109+
110+
The application uses a SQLite database. The connection string is configured in the `appsettings.json` file. Ensure you have the necessary SQLite tools installed to manage the database.

0 commit comments

Comments
 (0)