Spotlight is a gym networking app which aims to be an all-in-one tool for gym-goers to make friends, find ideal times to go to the gym, and share workouts. One of the biggest pet peeves of people who go to the gym is when the gym is overcrowded and no equipment is available. Spotlight will show gyms in your area and help you plan your workouts to better your gym experience.
The development of Spotlight is divided into 5 features: Authentication, Profile, Map, Calendar, and Friends List.
Firstly, authentication systems allow users to register a new account or log in, if they already have an account. There will be a profile section for the user profile. In the map section, you can see four gyms in Toronto that users can check the status and let other users know that the user is attending the specific gym. After clicking a specific gym, the user will be able to see other users that are at the gym and the age range etc.. The user will also be able to checkout other users by using search bar on the map screen. In the calendar section, users can add workouts and name it themselves. There is a friends section where the user can see all of their friends and check out their profiles. Users should be able to add new friends by searching their name.
First, download the latest apk from here.
- Users must first register an account if they haven’t already done so. Go to sign in with email -> create account. Enter the credentials and press create account. If a user has already created an account beforehand, they can enter their credentials in the login page and login. For demo purposes, you can use the following credentials: samuelvedrik@gmail.com, password: hellospotlight
- Once logged in, there are 4 screens that are available. Profile, map, calendar, friends. The profile screen is currently a mock of what we’re imagining the future profile screen to look like.
- The profile screen will display the information of the user. Includes their profile image, name, gender, age and a short description about themselves. Currently there is no data for the profile. So the user data in the profile page is hard coded.
- The gym screen displays a map with the available gyms that are supported. Clicking on a pin creates a pop up that displays information about the gym. Once you click the pop up, you can access detailed information about that gym. Currently there is no available data yet, so the information page is blank. There is also a search bar available that we’re planning to use to find other users, as per our partner’s request. This has yet to be implemented.
- The calendar screen displays a calendar that the user can select any date to highlight. If a date is highlighted, and “Add Workout” is pressed, the user will navigate to a screen where workout details can be added to that day’s workout (in this version, if no date is selected, users can still do this, but in the future this will not be the case). Currently, this information is not stored in a database, but users can see what it will feel like to add or remove workout information (type in details and press “Add” to add an exercise to a specific body part, press the exercise to remove it from your workout plan).
- The friends screen displays friend requests and friends, which are listed alphabetically. Clicking on a friend will display their profile. The profiles are currently blank slates. Friend requests are currently unimplemented, and will display similarly to friends.
Computer configuration setup:
-
Make sure that expo-cli is installed globally:
npm install --global expo-cli
-
Traverse to our github page and clone the project:
git clone https://github.com/csc301-fall-2020/team-project-18-spotlight
-
Install dependencies.
cd team-project-18-spotlight/spotlight npm i -
Start a development server with
expo start. Follow the instructions on the cli and/or webpage to set up the app. -
Mobile phone configuration setup:
- Install the expo app on your phone.
Step-by-step development process:
-
Type
expo startin the terminal. A tab should open in your browser with devtools. -
(Recommended) Using the expo app on your phone, scan the qr code in the devtools tab.
- Note: If nothing happens for a long time, close the app instance on your phone, reopen expo, and scan the code again.
- Expo was really buggy for us, sorry for any inconvenience.
Each person creates their own branch for each feature/bugfix they work on. Sometimes, a backend + frontend person will work together on the same branch. When someone finishes their work, they will submit a pull request and notify other members to review his/her code. After reviewing and resolving any potential merge conflicts, other members will approve the pull request. We try to get at least one other person to review each pull request, but this is not a hard rule. If the change is trivial enough, the person who made the PR can merge it themselves. Throughout the whole development process, we are using camelcase naming convention as we feel that it is easier to read and understand.
In terms of CI/CD, we have two separate github actions workflows. CI.yml runs a linter upon every pull request to master. In the future, it will also run a suite of unit tests. On the subject of linting, we also have pre-commit hooks which run prettier (to format) and ESlint (to lint) before every commit. This ensures consistent code quality throughout our repository. CD.yml will build the apk and publish it as a release on every push to master with a version tag. This will ensure that we aren't building the app on every change, which would be a huge waste of time and resources.
We’ll be applying the Apache License 2.0, meaning users of our open-source code must state changes made to our codebase. We made this decision as it was restrictive enough so that the work we created would be somewhat preserved as development on the code continues.