Skip to content

Commit 324846c

Browse files
committed
readme complete
1 parent 3784bf5 commit 324846c

File tree

4 files changed

+80
-16
lines changed

4 files changed

+80
-16
lines changed

README.md

Lines changed: 74 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,80 @@
1-
# study_mate
1+
<div style="overflow: auto;">
2+
<img src="https://i.imgur.com/5Pe9REQs.jpg" style="float: left; width: 100px; margin-right: 30px;">
3+
<h1 style="float: left;">Study Mate App</h1>
4+
</div>
25

3-
A new Flutter project.
6+
<br/>
47

5-
## Getting Started
8+
The Study Mate App is a cross-platform app designed using the Flutter framework designed to provide resources, courses, and lectures to students in an organized and easily accessible way. The app will be available on multiple platforms, including Android and Windows. This app is designed to be user-friendly, intuitive, and responsive to different screen sizes. The app also includes a notice/event section to keep users informed about recent events.
69

7-
This project is a starting point for a Flutter application.
10+
<!-- <br/> -->
811

9-
A few resources to get you started if this is your first Flutter project:
12+
## Features
1013

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
14+
Exploring the App
1315

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
16+
Upon successful login, you will be directed to the app's home screen which contains:
17+
18+
**Resources** - Navigate to the "Resources" section to explore a collection of study materials. Browse through PDFs, previous year question papers, and PowerPoint presentations and put them in Favorites.
19+
20+
**Courses** - Visit the "Courses" section to discover various study courses available. Access any desired course with just one click.
21+
22+
**Classroom** - Access the "Classroom" feature to participate in virtual classrooms and interactive learning sessions.
23+
Take part in activities, submit assignments, and track your progress.
24+
25+
**SAP Portal Integration** - You can login and access SAP Portal directly through this app.
26+
27+
**Favorites** - Utilize the "Favorites" feature to save your preferred resources, courses, or lectures for quick access.
28+
Mark an item as a favorite by selecting the star icon on the app.
29+
30+
**Lectures** - Explore the "Lectures" section to find educational lectures on various subjects. Browse through the available lectures, such as Gate Smashers, Algo Expert, and Coding Wizard. Select a lecture to watch or listen to the content.
31+
32+
**Notice/Events** - This section provides a central place for users to access timely information and stay up-to-date with any relevant notices.
33+
34+
**Profile Settings** - Customize your profile settings by accessing the profile or settings section within the app. Change theme to light or dark mode, see app users and give feedback.
35+
36+
## 📷Screenshots
37+
38+
<p><center>
39+
<img width="405px" alt="Example" src="https://i.imgur.com/5eKpqvX.jpg"/>
40+
<br></br>
41+
<img width="405px" alt="Example" src="https://i.imgur.com/ErKZFTll.jpg"/>
42+
<br></br>
43+
<img width="405px" alt="Example" src="https://i.imgur.com/F4tx52ml.jpg"/>
44+
<br></br>
45+
<img width="405px" alt="Example" src="https://i.imgur.com/dYbjirel.jpg"/>
46+
<br></br>
47+
<img width="405px" alt="Example" src="https://i.imgur.com/aL8Y6Dsl.jpg"/>
48+
</center>
49+
</p>
50+
51+
## 👥Authors
52+
53+
Alok Kumar
54+
55+
- GitHub: [@4-alok](https://github.com/4-alok)
56+
<br>
57+
58+
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/4-alok/)
59+
60+
Sneha Agarwal
61+
62+
- GitHub: [@Sneha280564](https://github.com/Sneha280564)
63+
<br>
64+
65+
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/sneha-agarwal-sa19)
66+
67+
Nitin Kumar
68+
69+
- GitHub: [@Nitin-45](https://github.com/Nitin-45)
70+
<br>
71+
72+
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/nitin-kumar-4a07681b8/)
73+
74+
## ⭐️ Support
75+
76+
Give a ⭐️ if you like this project! Also, you can reach out to any author, we will be glad to hear you.
77+
78+
## 📝License
79+
80+
This project is [MIT](https://github.com/Minor-Project-Study-Mate/StudyMate-App/blob/main/LICENSE) licensed.

lib/app/modules/about_page/views/about_page_view.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ class AboutPageView extends GetView<AboutPageController> {
2828
),
2929
body: Center(
3030
child: Container(
31-
constraints: const BoxConstraints(maxWidth: 600),
31+
constraints: const BoxConstraints(maxWidth: 700),
3232
child: ListView(
33-
padding: const EdgeInsets.all(16.0),
33+
padding: const EdgeInsets.all(7.0),
3434
children: [
3535
buildPersonCard(
3636
name: 'Alok Kumar',
@@ -78,7 +78,7 @@ class AboutPageView extends GetView<AboutPageController> {
7878
Card(
7979
elevation: 2.0,
8080
child: Padding(
81-
padding: const EdgeInsets.all(16.0),
81+
padding: const EdgeInsets.all(7.0),
8282
child: Column(
8383
children: [
8484
CircleAvatar(

lib/app/modules/auth_page/views/auth_View.dart renamed to lib/app/modules/auth_page/views/AuthView.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class AuthView extends GetView<AuthController> {
3030
child: Column(
3131
children: [
3232
SizedBox(
33-
height: 250,
33+
height: 200,
3434
child: Hero(
3535
tag: "app_logo",
3636
child: SvgPicture.asset(
@@ -221,7 +221,7 @@ class AuthView extends GetView<AuthController> {
221221
),
222222
],
223223
),
224-
const SizedBox(height: 30.0),
224+
const SizedBox(height: 20.0),
225225
Row(
226226
mainAxisAlignment:
227227
MainAxisAlignment.spaceBetween,

lib/app/routes/app_pages.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import 'package:get/get.dart';
33
import '../modules/about_page/bindings/about_page_binding.dart';
44
import '../modules/about_page/views/about_page_view.dart';
55
import '../modules/auth_page/bindings/auth_binding.dart';
6-
import '../modules/auth_page/views/auth_View.dart';
6+
import '../modules/auth_page/views/authView.dart';
77
import '../modules/course/bindings/course_binding.dart';
88
import '../modules/course/views/course_view.dart';
99
import '../modules/create_notice/bindings/create_notice_binding.dart';

0 commit comments

Comments
 (0)