https://github.com/probably-not/wopair
An application currently in development to allow people to find nearby users with like-minded preferences to workout with.
https://github.com/probably-not/wopair
elixir location-based phoenix-framework workout
Last synced: 6 months ago
JSON representation
An application currently in development to allow people to find nearby users with like-minded preferences to workout with.
- Host: GitHub
- URL: https://github.com/probably-not/wopair
- Owner: probably-not
- License: other
- Created: 2018-04-15T11:08:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-15T11:13:54.000Z (over 7 years ago)
- Last Synced: 2025-01-07T06:32:13.200Z (about 1 year ago)
- Topics: elixir, location-based, phoenix-framework, workout
- Language: Elixir
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# WorkoutBuddy - Demo: A yet unnamed workout app for matching people to workout together
[](https://gitlab.com/daVinciCEB/unnamed-workout-app/commits/master) [](https://gitlab.com/daVinciCEB/unnamed-workout-app/commits/master)
The WorkoutBuddy - Demo is a yet unnamed workout app designed to match people to workout together. Think Tinder, for workout buddies!
**Buddies** *(people looking for workout buddies)* will be able to set up their profiles with preferences about how often they like to work out, and what kind of workouts they enjoy and have experience with, along with a distance radius to show how far away they are willing to look for a workout buddy. Their location will be automatically set from their location services on their phone/tablet/computer (constantly updating as the app is turned on). Once their profiles are set up, the application will show the other workout buddies that are within the radius that they have chosen, along with a "Match Percentage" to show how well the buddy matches their profile. The higher the percentage, the more the buddy matches the user's preferences.
## Development
The application will be built in two separate phases: [Phase 1 (Backend API Development)](#phase-1-backend-api-development) and [Phase 2 (Frontend Application Development)](#phase-2-frontend-application-development)
### Phase 1: Backend API Development
Phase 1 will be developing the Backend API, which will be built using the [Phoenix Framework](http://phoenixframework.org/). The API is being built with speed and scalability in mind, [hence using the Phoenix Framework](http://www.phoenixframework.org/blog/the-road-to-2-million-websocket-connections).
#### API TODOs
- [x] Data Model needs to be set up
- [x] API needs to be created with full JSON REST
- [x] Users will be able to login and logout
- [ ] Users will have various roles available to them (User, *Premium User*, *Promoted Trainer*)
- [x] If a user signs in, the API will return other Buddies within the specified radius of the user
- [ ] Users should be able to like or dislike Buddies
- [ ] Liked Buddies should go to the users's saved Buddies
- [ ] Disliked Buddies should be hidden from the user
- [ ] Each user will have a Match Percentage calculated for each Buddy they see
### Phase 2: Frontend Application Development
Phase 2 will be developing the native applications for each platform that the application will be used on. The aim is to create an Android application, an iOS application, and a Web Application, so that all phone users can use the platform. Since [Phase 1](#phase-1-backend-api-development) will be developing the full backend, the native applications will only need to query the API, so there should be no heavy lifting on the application side.
#### Frontend TODOs
- [ ] Create Web Application
- [ ] Create iOS Application
- [ ] Create Android Application