Skip to content

Commit

Permalink
chore: edited readme for better onboarding to the project
Browse files Browse the repository at this point in the history
  • Loading branch information
IamMuuo committed Sep 6, 2024
1 parent a4746b5 commit 9ad3b02
Showing 1 changed file with 62 additions and 21 deletions.
83 changes: 62 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,81 @@
<img src="assets/icons/academia.png">
![Logo](assets/icons/academia.png)


# Academia

"Academia" is a 📱 mobile app 🎓🏫 exclusively designed for Daystar University students, tailored to streamline their academic experience. With Academia, Daystar students can effortlessly manage their class schedules 🗓️, assignments 📚, exams 📝, grades 📊, and more, all within a single, user-friendly platform. The app harnesses the power of 🚀 Flutter, a versatile mobile app SDK for building high-performance, cross-platform apps for iOS, Android, web, and desktop, all from a unified codebase. 📲
Academia is an open-source mobile application designed specifically for Daystar University students.


## Features

- Chirp - Daystar's social platform
- Course Tracking
- Student transcripts and audits
- Flash Cards
- Ai Study with me
- Todos


## Run Locally

Please ensure that you have [Flutter](https://flutter.dev) installed on your machine

Clone the project

```bash
git clone https://github.com/IamMuuo/academia.git
```

Go to the project directory

```bash
cd academia
```

Install dependencies

```bash
flutter pub get
```

Run the application

```bash
flutter run
```


## Documentation

The application's source code is self documenting. For the backend the postman exports are also available on the `docs` folder.

Incase of any query about documentated with inline comments you can always reach out to any of the project maintainers or DITA for more information

Academia is powered by magnet for scraping data
## Authors

## Features 🔥🚀
- [@Erick](https://www.github.com/iammuuo)

📅 **Schedule:** Keep track of all your classes and lectures with the built-in calendar.
## Screenshots

📝 **Assignments:** Track all your assignments and their deadlines in one place.
![App Screenshot](screenshots/shot.png)

📚 **Course Material:** Access all your course material in one place, including lecture notes, PDFs, and videos.

📈 **Grades:** Keep track of your grades throughout the semester.
## Contributing

💬 **Announcements:** Stay up-to-date with the latest announcements from your school or professor.
Contributions are always welcome!

🔔 **Reminders:** Get notified about upcoming assignments, exams, and other important events.
See `contributing.md` for ways to get started.

## Screenshots 📷
Please adhere to this project's `code of conduct`.

![Screenshot](screenshots/shot.png)

## Getting Started 🚀
## Support

1. Install [Flutter](https://flutter.dev/docs/get-started/install).
2. Clone this repository: `git clone https://github.com/IamMuuo/academia.git`
3. Install dependencies: `flutter pub get`
4. Run the app: `flutter run`
For support, you can open a github issue or mail dita@daystar.ac.ke

## Contributing 🤝
We would really appreciate if you reported bugs or even made features for you and your fellow students to use and enjoy!

Contributions are always welcome! If you have any ideas or suggestions, please open an issue or submit a pull request. For more information, please see [CONTRIBUTING.md](CONTRIBUTING.md).
## License

## License 📝
[MIT](https://choosealicense.com/licenses/mit/)

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

0 comments on commit 9ad3b02

Please sign in to comment.