Skip to content

Commit dc4324a

Browse files
mgaddafymgaddafy
authored
Create README.md
1 parent 22cc698 commit dc4324a

File tree

1 file changed

+228
-0
lines changed

1 file changed

+228
-0
lines changed

‎README.md

+228
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
1+
# 🔑 **Uni-Compact** 🔑
2+
3+
<p align="center">
4+
<a href="">
5+
<img width="100%" src="" alt="@nirobhasan-git">
6+
</a>
7+
<br>
8+
<a href="">
9+
<img src="https://img.shields.io/github/issues/Josee9988/project-template?color=0088ff&style=for-the-badge&logo=github" alt="https://github.com/nirobhasan-git/"/>
10+
</a>
11+
<a href="">
12+
<img src="https://img.shields.io/github/issues-pr/Josee9988/project-template?color=0088ff&style=for-the-badge&logo=github" alt="https://github.com/nirobhasan-git/"/>
13+
</a>
14+
<a href="">
15+
<img src="https://img.shields.io/badge/use%20this-template-blue?logo=github-sponsors&style=for-the-badge&color=green" alt="https://github.com/nirobhasan-git/">
16+
</a>
17+
</p>
18+
19+
---
20+
21+
## 🤔 **What is this project all about?**
22+
23+
* A website designed for an academic institution is complex and works best on a desktop.
24+
Unless a website is specially designed to be mobile compatible, it is generally inconvenient to
25+
use websites with complex functionalities that have been scaled down to a small screen device.
26+
* Uni-compact focuses on serving mobile users by being an all-in-one, convenient and robust app
27+
that is able to provide all academically relevant information while maintaining its core objective
28+
of being ‘compact’ and ‘simple’.
29+
* Uni-Compact is able to cater to entities both internal and external relative to the organization
30+
and its needs. Providing all the functionalities of a full-fledged desktop website such as checking
31+
a student’s academic performance, status, events, news, and course materials to authority level
32+
operations implementing C-R-U-D on the institution's database system while also maintaining
33+
security and isolation of information in accordance with institution policies on privacy.
34+
* Make your project easy to maintain with **this project**.
35+
36+
---
37+
38+
## ⚡ **Installation** React Native on Windows:
39+
40+
1. Install the [🤖 GitBash](https://git-scm.com/downloads) (recommended)
41+
2. `Prerequisites:`
42+
- [ ] Install [NodeJS](https://nodejs.org/dist/v14.17.3/node-v14.17.3-x64.msi) from this link.
43+
- [ ] Download and install [Visual Studio](https://code.visualstudio.com/docs/?dv=win) Code from this link.
44+
3. **For Physical Devices:**
45+
- [ ] For iOS : Download and install [Expo Go](https://apps.apple.com/us/app/expo-go/id982107779) from this link.
46+
- [ ] For Android: Download and install [Expo](https://play.google.com/store/apps/details?id=host.exp.exponent&hl=en&gl=US) from this link.
47+
4. `For Using Emulators on Windows:`
48+
- [ ] Install [Android Studio](https://r5---sn-npoeene6.gvt1.com/edgedl/android/studio/install/2022.1.1.20/android-studio-2022.1.1.20-windows.exe?mh=_v&pl=24&shardbypass=sd&redirect_counter=1&cm2rm=sn-fja-q5je76&req_id=c084d920d2a608c0&cms_redirect=yes&mip=103.150.49.2&mm=42&mn=sn-npoeene6&ms=onc&mt=1675283401&mv=u&mvi=5&rmhost=r2---sn-npoeene6.gvt1.com&smhost=r4---sn-npoldne7.gvt1.com) from this link.
49+
5. To create a new folder in your hard drive, **[Or ask me](https://www.facebook.com/justnirob/)**; for more information or guidance.
50+
6. Powershell Execution Policy **Error**:
51+
Open Windows Powershell in ```bash RUN AS ADMINISTRATOR ``` mode.
52+
- [ ] Use the following command:
53+
```bash Set-ExecutionPolicy -ExecutionPolicy RemoteSigned ```
54+
7. Now go to the project folder with [GitBash], [CMD] or with the [Visual Studio Code] terminal.
55+
8. **Run** the code `git init` and clone with this command `git clone https://github.com/nirobhasan-git/uni-compact.git` and `cd` into it.
56+
9. Now install with this all `command:`
57+
```bash
58+
npm install
59+
npm install @react-navigation/native @react-navigation/stack
60+
expo install react-native-reanimated react-native-gesture-handler react-native-screens react-native-safe-area-context @react-native-community/masked-view
61+
npm install @react-navigation/material-bottom-tabs react-native-paper
62+
npm install @react-navigation/drawer
63+
npm install react-native-elements
64+
npm install @rneui/themed @rneui/base
65+
```
66+
10. **To run ** the `Project`.
67+
68+
```bash
69+
npx expo start
70+
```
71+
72+
Or
73+
74+
```bash
75+
expo start
76+
```
77+
78+
Additionally, watch *[this video](https://www.youtube.com/watch?v=GyHSPrFh9QM)* to see **how to run Expo with React Native**.
79+
80+
11. **Review** every single file and **customize** it as you like.
81+
12. Build your project by your own. 🚀
82+
83+
⚠️ _Customize every file to fit your requirements_ ⚠️
84+
85+
---
86+
87+
## 📚 **What does it include?**
88+
89+
1. A
90+
The script will customize all the data with yours in all the files.
91+
92+
1. A
93+
2.
94+
3.
95+
4.
96+
5.
97+
6.
98+
1. A
99+
2. A
100+
3. A
101+
4. A
102+
5. A
103+
6. A
104+
105+
---
106+
107+
### 🌲 **Project tree**
108+
109+
All about our project featurs! 🙈
110+
111+
```text
112+
Login Page
113+
----------
114+
Login as:
115+
Student
116+
Faculty
117+
Parent
118+
Department
119+
Username:
120+
Password:
121+
Forget Password?
122+
123+
Similar Homepage
124+
CMS, Notes, Events, Results
125+
1. Page Title.
126+
2. Loged in user's Full Name And Email.
127+
3. CMS - Course List, Class Attended, Total Class.
128+
4. Trimester Name.
129+
5. Show Announcement.
130+
6. Logout.
131+
Student Homepage
132+
1. CGPA, GPA.
133+
2. Advisor Name.
134+
3. Can Download Faculty's Notes/Course Outline.
135+
4. CGPA Calculator.
136+
Faculty Homepage
137+
1. Enrolled student's information Search.
138+
Students Name, Fathers Name, Mothers Name, Parent Contact, Attendence, Results, Num of trimester.
139+
2. Can upload course outline in any individual courses.
140+
3. General News Publish For Student's.
141+
4. Daily Schedule.
142+
Parent Homepage
143+
1. Faculty Information.
144+
2. Student's Attendance Summary.
145+
3. Course List.
146+
4. Results.
147+
Department Homepage
148+
1. Faculty List + CRUD
149+
2. Student List + CRUD
150+
3. Parent List + CRUD
151+
4. Own Information + CRU
152+
5. Assign Faculty's For Courses.
153+
6. Assign Student's For Courses.
154+
7. Event's + CRUD
155+
8. Publish Scolership List.
156+
8. Set Faculty Scedule.
157+
158+
Some features may be more or less.
159+
```
160+
161+
---
162+
163+
## 📝 **Additional notes**
164+
165+
* Lorem ipsum dolor sit amet, consectetur adipiscing elit.
166+
167+
* Lorem ipsum dolor sit amet, consectetur adipiscing elit.
168+
169+
* If you are using **Windows**.
170+
1. Install **[git for Windows](https://git-scm.com/download/win)**.
171+
2. Right-click on the git repository folder and click "*git bash here*".
172+
3. Then just perform all the code above.
173+
174+
---
175+
176+
## 📸 **Screenshots**
177+
178+
A couple of screenshots to delight you before you use this project.
179+
180+
### 🔺 All the issue
181+
182+
### 🔻 An issue opened
183+
184+
### 📘 The README can be downloaded from here.
185+
186+
Badges and texts will be replaced with your project details!
187+
188+
<p align="center">
189+
Link is pending.
190+
</p>
191+
192+
### 🔖 Pending
193+
194+
195+
### 📝 Pending
196+
197+
198+
### 🛡️ Pending
199+
200+
201+
### 💼 Pending
202+
203+
---
204+
205+
## 🕵️ **Pending**
206+
207+
208+
## 💉 **Pending**
209+
210+
---
211+
212+
## 🍰 **Pending**
213+
214+
215+
---
216+
217+
## 🎉 Was the project helpful? Please help us raise these numbers up
218+
219+
[![LinkedIn Badge](https://img.shields.io/badge/LinkedIn-Profile-informational?style=flat&logo=linkedin&logoColor=white&color=0D76A8)](https://www.linkedin.com/in/nirob-hasan/)
220+
[![Twitter Badge](https://img.shields.io/badge/Twitter-Profile-informational?style=flat&logo=twitter&logoColor=white&color=1CA2F1)](https://twitter.com/NirobHasan_com)
221+
222+
Enjoy! 😃
223+
224+
> ⚠️ Remember that this project should be reviewed and modified to fit your requirements.
225+
> I created this as a University project.
226+
> There will be some files that will need *manual revision* ⚠️
227+
228+
_Made with a lot of ❤️ by **[@nirobhasan-git](https://github.com/nirobhasan-git)**_

0 commit comments

Comments
 (0)