Skip to content

Commit f90e87d

Browse files
committed
chore(project): update readme
1 parent 625b746 commit f90e87d

File tree

5 files changed

+34
-7
lines changed

5 files changed

+34
-7
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
1-
# Vidya: School Organization Platform
1+
<p align="center">
2+
<img src="docs/images/logo.png" height="184px"/>
3+
</p>
24

3-
Vidya is a school organization platform that helps schools manage their students, teachers, and courses. It provides a simple and intuitive interface for managing school data and generating reports.
5+
<p align="center"><i>
6+
Vidya is a Learning Management System (LMS) crafted to revolutionize education by enabling you to establish and manage your own schools, complete with students, teachers, and more. It empowers students with the flexibility to learn anytime, anywhere through a state-of-the-art mobile application.
7+
</i></p>
48

9+
<p align="center">
10+
<a href="#">
11+
<img src="docs/images/splash.png"/>
12+
</a>
13+
<a href="#">
14+
<img src="docs/images/download-app-store.png" height="50">
15+
</a>
16+
<a href="#">
17+
<img src="docs/images/download-google-play.png" height="50">
18+
</a>
19+
</p>
520

6-
## Services
21+
## Features
722

8-
| Service | Host |
9-
| ------------ | --------------------- |
10-
| API: Swagger | http://localhost:8080 |
11-
| Mail | http://localhost:8025 |
23+
1. 🏫 **School Management Made Easy** Open and manage your own school. Invite students, onboard teachers, and handle everything from one dashboard.
24+
25+
2. πŸ“š **Course Creation** Build structured courses with lessons and homework. Organize your curriculum exactly the way you want.
26+
27+
3. 🌐 **Multi-Platform Access**
28+
Students can join your school via a user-friendly website or mobile app β€” learning made simple and accessible.
29+
30+
4. πŸ› οΈ **Your Brand, Your Domain**
31+
Want a fully branded school on your custom domain? Need a dedicated mobile app? No problem β€” Vidya generates it for you automatically.
32+
33+
## Get involved
34+
If you'd like to help develop the project, here's a list of links to get you started:
35+
36+
1. [Development Environment](<docs/Development Environment.md>) – Configure your development enviroment to get started.
37+
2. [Good First Issues](https://github.com/akdasa-studios/vidya/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) – a list of simple issues any developer could start from.
38+
3. [Roadmap](https://github.com/orgs/akdasa-studios/projects/13/views/4) - list of tasks we are working on.
82.7 KB
Loading
70.2 KB
Loading

β€Ždocs/images/logo.pngβ€Ž

137 KB
Loading

β€Ždocs/images/splash.pngβ€Ž

540 KB
Loading

0 commit comments

Comments
Β (0)