You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 9, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,10 @@
6
6
## The Open Event Android Client
7
7
8
8
The Android client is a generic app that has two parts:
9
+
9
10
a) A standard configuration file, that sets the details of the app (e.g. color scheme, logo of event, link to JSON app data)
10
-
b) The Android app itself
11
-
This app uses the json api provided by a server maintained [here](https://github.com/fossasia/open-event-orga-server).
11
+
12
+
b) This app uses the json api provided by a server maintained [here](https://github.com/fossasia/open-event-orga-server).
12
13
13
14
## Development Setup
14
15
Before you begin, you should already have the Android Studio SDK downloaded and set up correctly. You can find a guide on how to do this here: [Setting up Android Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio)
@@ -24,6 +25,7 @@ Before you begin, you should already have the Android Studio SDK downloaded and
24
25
25
26
- *Note:* If you recieve a Gradle sync error titled, "failed to find ...", you should click on the link below the error message (if avaliable) that says *Install missing platform(s) and sync project* and allow Android studio to fetch you what is missing.
26
27
- *Note:* If you are trying to build this project on a Windows Machine, you should **Comment** out line number 5 and **Uncomment** line number 6 inside build.gradle(Project: app).
28
+
27
29
5. Once all build errors have been resolved, you should be all set to build the app and test it.
28
30
29
31
6. To Build the app, go to *Build>Make Project* (or alternatively press the Make Project icon in the toolbar).
@@ -32,14 +34,18 @@ Before you begin, you should already have the Android Studio SDK downloaded and
32
34
33
35
### Screenshots
34
36

37
+
35
38

39
+
36
40

41
+
37
42

38
43
39
44
### Configuring the app
40
45
41
46
**Configuring Server and Web-App Urls**
42
47
- Browse the project directories and open (with Android Studio): *app/src/main/java/org/fossasia/openevent/api/Urls.java*
48
+
43
49
- In this file you will see several constant variables that allow you to set useful properties of the app, these include:
44
50
* API_VERSION: Server API version. (Example: "v1")
45
51
* EVENT_ID: ID of the event to load from server. (Example: 1)
@@ -53,20 +59,24 @@ Before you begin, you should already have the Android Studio SDK downloaded and
53
59
54
60
**Configuring App Theme / Localizations**
55
61
- The styles.xml files have been configured to allow easy customization of app themes.
62
+
56
63
- You can configure themes by changing various components found in the styles.xml files, found at:
57
64
* */app/src/main/res/values/styles.xml*
58
65
* */app/src/main/res/values-v21/styles.xml*
59
66
67
+
60
68
- Using *Theme Editor*:
61
69
* You can also configure the theme of the app using Android Studio's *Theme Editor*.
62
70
* Go to *Tools>Android>Theme Editor* to open the Theme Editor.
63
71
* From there you can configure the colors and styles of in-app elements using a neat UI.
64
72
73
+
65
74
-*Translations Editor*:
66
75
* You can configure the string localizaions / translations using Android Studio's *Translations Editor*.
67
76
* Find /app/src/main/res/values/strings.xml
68
77
* Right click on the file, and select *Open Translations Editor*.
69
78
79
+
70
80
- Editing Manually:
71
81
* You can find the configuration files for the app for manual editing here:
72
82
* */app/src/main/res/values/*
@@ -80,12 +90,14 @@ Before you begin, you should already have the Android Studio SDK downloaded and
80
90
- Also there is a check on the version of data already there in the app's database. If data is stale then only it is downloaded.
81
91
- If database is empty then firstly json file in assets is accessed but if internet is available , latest data is downloaded.
82
92
83
-
## Libraries userd
93
+
## Libraries used
84
94
- Otto
85
95
- Retrofit
86
96
- ButterKnife
87
97
- Timber
88
98
- Google Gson
99
+
- LeakCanary
100
+
- Picasso
89
101
90
102
## Branches and Contribution policy
91
103
We have the following branches
@@ -104,5 +116,5 @@ We have the following branches
104
116
## A note about Codestyle
105
117
Please read our [CODESTYLE](CODESTYLE.md) carefully. Pull requests that do not match the style will be rejected.
106
118
107
-
##License
119
+
##License
108
120
This project is currently licensed under the GNU General Public License v3. A copy of LICENSE.md should be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.
0 commit comments