Skip to content

Commit dcf81c6

Browse files
authored
Update README.md
1 parent ca90f49 commit dcf81c6

File tree

1 file changed

+60
-8
lines changed

1 file changed

+60
-8
lines changed

README.md

Lines changed: 60 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,67 @@
11
# Active Learning and Teaching App :iphone:
2-
An open source mobile application to facilitate teaching and learning.
2+
An open-source mobile application to facilitate teaching and learning in courses, including taking quizzes and feedbacks efficiently in classes.
33

44
<img width="731" alt="Screenshot 2021-04-30 at 18 16 51" src="https://user-images.githubusercontent.com/42066451/116697230-8e4b4c80-a9e0-11eb-860d-6fca12a876f5.png">
55

6-
## Build :gear:
6+
## Folder Structure 📁
77

8-
- Clone the repository
9-
- Place **config.json** in App/
10-
- Place **google-services.json** in App/android/app/
11-
- Place **GoogleService-Info.plist** in App/ios/
12-
- **iOS:** `react-native run-ios`
13-
- **Android:** `react-native run-android`
8+
```
9+
├── App
10+
│   ├── App.js
11+
│   ├── Assets
12+
│   ├── Components
13+
│   ├── Databases
14+
│   ├── NotificationCenter.tsx
15+
│   ├── Utils
16+
│   ├── __tests__
17+
│   ├── android
18+
│   ├── app.json
19+
│   ├── babel.config.js
20+
│   ├── config.json
21+
│   ├── firebase.json
22+
│   ├── functions
23+
│   ├── index.js
24+
│   ├── ios
25+
│   ├── metro.config.js
26+
│   ├── node_modules
27+
│   ├── package-lock.json
28+
│   ├── package.json
29+
│   └── patches
30+
├── Architecture.jpeg
31+
├── README.md
32+
└── SRS.MD
33+
```
1434

35+
## Setup 📥
1536

37+
1. Clone the repository to local machine
38+
```sh
39+
git clone https://github.com/SDOS-Winter2021/Team_1_ALT.git
40+
```
41+
2. Install Node Modules
42+
```sh
43+
cd App
44+
npm install --legacy-peer-deps
45+
```
46+
3. Install CocoaPods
47+
```sh
48+
cd ios
49+
pod install
50+
```
51+
6. Place `config.json` in App/
52+
7. Place `google-services.json` in App/android/app/
53+
8. Place `GoogleService-Info.plist` in App/ios/
54+
55+
## Build ⚙️
56+
57+
### iOS
58+
`react-native run-ios`
59+
### Android
60+
`react-native run-android`
61+
62+
## Release ⬇️
63+
You can install the latest stable version of the app from Releases. The Android app is available as APK and iOS app is available through TestFlight.
64+
65+
## Team ⭐
66+
67+
``` Anuneet Anand | Divyam Gupta | Vishwesh Kumar | Yashdeep Prasad ```

0 commit comments

Comments
 (0)