... | ... | @@ -3,7 +3,32 @@ |
|
|
|
|
|
# Source Code
|
|
|
|
|
|
Our master project source code is available in our repository [***HERE***](https://git.cs.usask.ca/test_alpha/project_1/-/tree/master).
|
|
|
## Overall Files Used
|
|
|
Code for the repository can be found [***here***](https://git.cs.usask.ca/test_alpha/project_1/-/tree/master).
|
|
|
|
|
|
Most of the files for the Android application are auto-generated into a set location. This does not leave us with a lot of freedom for changing around the file locations or structure. The link above will take you to the entrance of the source code where most of the files and folders are set in place.
|
|
|
|
|
|
## Main Files Used
|
|
|
|
|
|
The main files that were used can be found [***here***](https://git.cs.usask.ca/test_alpha/project_1/-/tree/develop/app%2Fsrc%2Fmain).
|
|
|
### main
|
|
|
The files that we spent most of the time writing can be found project_1/app/src/main, this is where the link above takes you.
|
|
|
Here is where we started to structure our files. There are three important parts in this folder.
|
|
|
1. java/com/zizzle/cmpt370 - This folder is where all the java files are kept that give the app functionality.
|
|
|
2. res - This is the resource folder that stores all the xml files that include pages, pictures, and layouts of the app.
|
|
|
3. AndroidManifest.xml - This is the master file that keeps track of the pages that are in the app.
|
|
|
|
|
|
### java/com/zizzle/cmpt370
|
|
|
Diving into the java/com/zizzle/cmpt370 folder, We will see folders two new folders (Activities and Model) and some java files that didn't fit into either.
|
|
|
1. Activities - Where we store the activities. If you are unfamiliar with Android Studio, an Activity is equivalent to a page in an app.
|
|
|
2. Model - This is where the our custom classes for Member, Team, League, etc. are stored.
|
|
|
|
|
|
### res
|
|
|
Going back to the main folder that we started at, We can take a look into res folder. The folders in here were auto-generated but each has a specific purpose.
|
|
|
1. anim - This is where the custom animations are stored, we used this to add the animation between pages.
|
|
|
2. drawable / drawable-v24 - This is where we built custom buttons, cards and backgrounds to use later.
|
|
|
3. layouts - This is the most used folder in res. This is where the layout of each page is kept, inside here we have subfolders that contain the layouts for specific pages because often times more than one layout file was needed per page.
|
|
|
4. menu - This is where the files for the navigation menu are stored.
|
|
|
5. mipmap (all) - These folders all contain different resolutions of the same images. The app will choose from these folders the best image to display depending on the resolution of the given device.
|
|
|
6. values - This is where often used values are stored so we can call the variable name instead of hardcoding it everytime. An example would be custom hex colours that would be used for text.
|
|
|
|
|
|
[EXPLAIN HOW WE STRUCTURED THE FILES/FOLDERS] |
|
|
\ No newline at end of file |