Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@parvez-ahammed
parvez-ahammed authored Jul 6, 2024
1 parent a296699 commit 1d10d61
Showing 1 changed file with 0 additions and 98 deletions.
98 changes: 0 additions & 98 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,101 +15,3 @@

## [Project Proposal](https://docs.google.com/document/d/12CXztwjrIJd7QOpV3nL1Zi-9QiyS5IiKwkkKdMAgng0/edit?usp=sharing)
## [UI](https://www.behance.net/gallery/170334575/UI-Case-Study-AUST-Buddy)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/piru72"><img src="https://avatars.githubusercontent.com/u/63257806?v=4" width="100px;" alt=""/><br /><sub><b>Parvez Ahammed</b></sub></a><br /><a href="https://github.com/piru72/AUST_BUDDY/commits?author=piru72" title="Code">💻</a> <a href="#ideas-piru72 title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/piru72/AUST_BUDDY/issues?q=author%3Apiru72" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/arman-mahy"><img src="https://avatars.githubusercontent.com/u/77797657?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Arman Mahy</b></sub></a><br /><a href="https://github.com/piru72/AUST_BUDDY/commits?author=arman-mahy" title="Code">💻</a> <a href="#ideas-arman-mahy title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/arman-mahy/AUST_BUDDY/issues?q=author%3A" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/klutz-me"><img src="https://avatars.githubusercontent.com/u/82176462?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sabbir Ahmed Salman</b></sub></a><br /><a href="https://github.com/klutz-me/AUST_BUDDY/commits?author=klutz-me" title="Code">💻</a> <a href="#ideas-klutz-me title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/klutz-me/AUST_BUDDY/issues?q=author%3Aklutz-me" title="Bug reports">🐛</a></td>


</tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->


# INTRODUCTION

> ## 1.1 Overview <br>
>
> The "AUST BUDDY" project is a university assistant application for different students. This mobile application is built in Android Studio and is developed in kotlin and the database is managed by Firebase.
> ## 1.2 Purpose<br>
>
> This software primarily focuses on maintaining, viewing, saving, and storing the different things of a student to make life easier. As well as some unique features there are also basic features such as user login. After completing a signup form new users can sign in easily. One will be able to register using the university email only and password. It has a facility where a student will be getting different announcements like blood donation requests etc.
They can also find materials links, Aust website’s, teacher’s info, create groups, post quiz schedules in a group, get bus timings, calculate GPA, bookmark websites, post requests to admin for materials and teachers, create a favorite teacher list, and contact the teachers easily.
Overall, the primary goal of this project is to provide a hassle-free semester for users as well as to save time looking for notes and questions here and there. It will be a valuable asset while taking preparation for the final.


> > ## 1.2.1 Background Study<br>
> >
> > The application is developed for automating the searching of notes, and questions, getting news, and calculating CGPA. The application will be a great relief to the backbencher who’s been chilling the whole semester but wants to ace the finals and also to the nerd who’s trying to score 102% in the final. So won’t it be helpful for the person who’s looking to do average? yes, calculate and analyze your results even before the exams and ace the exam according to that plan!
> > ## 1.2.2 Benefits and Beneficiaries<br>
> >
> > Users are the main beneficiaries of this system. But all the people related to our Project area are also beneficiaries. Benefits are given below<br><br>
Implemented Features:

• Onboarding pages
When the users will log in for the first time they will get the onboarding pages to get an idea about the app and its features.

• Sign In and Sign up
Users can register an ID in this application. At first, they need to register using their valid institutional mail and they need to verify their email to register, and later they need to sign in using those credentials.

• Announcement
Users can make announcement about different things in feature called Plaza. There are some category’s and topic to select what about the announcement is. There are also contact feature added so that anyone can contact the announcer. User can search here for university seminars, club recruitment, workshop, find roommates, academic product sale, seeking for blood etc.

• Useful Webviews.
There are several web views on the homepage which a student might need in their regular life. They can use those features from the app. Added webviews are -
1. IUMS – Students can do their educational-related work from here.
2. Calender- academic calender for every semester can be found here.
3. Notice Board – Students can check the latest notice from AUST.

• CGPA calculator.
Student can calculate their CGPA by only entering their result on individual courses. Also, they can choose their semester which will reset the interface and bring their semester courses credits.

• Teacher Information
Students can find techers information in this app. Teachers information are sorted in department wise. Teachers mail, contact number and image are added here. Students can also call teacher from the app.

There is another feature called favourite, where students can bookmark their favourite teachers. So that they find them easily.

• Check bus schedule
Students can have all the information about university buses as bus names, routes, time schedule.

• Bookmark Option
Students can bookmark their favourite websites, links in this feature. So that they can find them easily.

• Resource links
Student can find their desired course resources from here. Course resources are mainly google drive links which contains lecture videos, notes, books, and previous semester questions. Resources are sorted in semester wise.

• Quiz Listing in Group
Students can open groups here for their section and admin can schedule their quiz and quiz syllabus. Other students can join the same group through group id. They can also delete that quiz. The data are stored in the real-time database. A pop-up window will arise and take the inputs and save them into the real-time database.

• Profile
Students can see their information in My Profile option.
Students can change their password in settings.
Students can invite their friend to use this app via email. Multiple people can be invited at the same time by giving their emails separated by a comma. Also user can logout from the app.


• Request
Students can request for course, teacher and feature from the admins. The admin then can update the materials via google drive or via firebase. Students also can report bug in this option.

• Database
Firebase's real-time database has been used to store data and an authentication feature is used to authenticate users. Also firebases email sending feature has been used to verify emails.
All the references.

• Others
This app also have dark mode to make it more user friendly.

0 comments on commit 1d10d61

Please sign in to comment.