Skip to content

Commit f7b29be

Browse files
committed
Even more README updates
1 parent 91e8479 commit f7b29be

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Course-Compass
22
## by team [Inference](https://inferencekth.github.io/Course-Compass/)
3-
Course-Compass is a webpage for interacting with the kth courses via the kth api. It allows for searching and filtering through all active courses.
3+
Course-Compass is an interactive web application for exploring KTH courses. It allows users to search, filter, and review courses while providing prerequisite visualization and personalized recommendations. The application uses Firebase for data storage and real-time updates.
4+
45

56
## Features
67
- Course search with advanced filtering
@@ -65,6 +66,35 @@ REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
6566
REACT_APP_FIREBASE_APP_ID=your_app_id
6667
```
6768

69+
### Database Population
70+
To populate the Firebase database with course data:
71+
72+
1. Use the JSON file in `/src/assets/example.json` or prepare a file according to the following outline:
73+
```json
74+
{
75+
"courseCode": {
76+
"code": "string",
77+
"name": "string",
78+
"location": "string",
79+
"department": "string",
80+
"language": "string",
81+
"description": "string",
82+
"academic_level": "string",
83+
"periods": "array",
84+
"credits": "number",
85+
"prerequisites": "object",
86+
"prerequisites_text": "string",
87+
"learning_outcomes": "string"
88+
}
89+
}
90+
```
91+
92+
2. Use the `model.populateDatabase(data)` function to upload courses:
93+
```javascript
94+
import data from "./assets/example.json";
95+
model.populateDatabase(data);
96+
```
97+
6898
### Firebase Security Rules
6999
<details>
70100
<summary>Click to view Firebase Rules</summary>

0 commit comments

Comments
 (0)