Skip to content

2022-csc-59866/AthleteLink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

79 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

Athlete Link

Introducing Athlete Link, the ultimate platform for fitness enthusiasts and athletes to connect, train, and reach their fitness goals together. With our innovative and user-friendly     interface, finding the perfect training partner has never been easier.

  Swipe, match, and connect! Athlete Link offers a seamless and engaging experience similar to popular dating apps. Browse through a diverse community of fitness enthusiasts in your area, and with a simple swipe, indicate your interest in their profile. Whether you're looking for a workout buddy, a running partner, a yoga companion, or someone to hit the weights with, Athlete Link is here to help you find your ideal training match.

  But it doesn't stop there! Once you've found a match, our real-time chat feature allows you to connect instantly and start planning your training sessions. Coordinate schedules, exchange fitness tips, and motivate each other towards success. Athlete Link creates a supportive and dynamic environment where you can build meaningful connections with like-minded individuals who share your passion for fitness.

  Looking for a gym to train at? We've got you covered. Athlete Link provides a comprehensive gym-finder feature that enables you to locate nearby fitness facilities tailored to your preferences. Whether you prefer a traditional gym, a specialized studio, or outdoor training spaces, our app will guide you to the perfect location that meets your specific needs.

  Key Features:

  Swipe and Match: Explore user profiles and indicate your interest with a simple swipe.
  Real-time Chat: Connect with your training partner and plan workouts in a seamless messaging interface.
  Gym Finder: Discover nearby gyms and fitness facilities based on your preferences.
  Profile Customization: Showcase your fitness journey, interests, and goals through a personalized profile.
  Privacy and Safety: We prioritize the privacy and safety of our users, ensuring a secure and enjoyable experience.
  Join the thriving fitness community on Athlete Link and unlock a world of training opportunities. Whether you're a beginner taking your first steps towards a healthier lifestyle or a seasoned athlete looking for new challenges, our app is designed to empower you on your fitness journey. Download Athlete Link now and let's get ready to train together!
<br />

<br />


View Demo
2023-05-17.14-53-20.mp4

Report Bug
Request Feature
Table of Contents
  1. About The Project
  2. Getting Started
  3. Prerequisites
  4. Installation
  5. Usage
  6. Roadmap
  7. Contributing
  8. License
  9. Contact
  10. Acknowledgments

About The Project

Product Name Screen Shot

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

Built With

  • React
  • Firebase
  • Express JS
  • Node JS

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Get a free API Key at Google Developers Api Explorer
  2. Clone the repo
    git clone https://github.com/2022-csc-59866/AthleteLink.git
    
  3. Install NPM packages
    npm install
    
  4. Enter your Firebase Configurations in api/server/config.js
    Update admin.initializeApp({}) with firebase configuration
    
  5. Enter your Firebase Configurations in src/firebase.js
    Update firebaseConfig with your own apiKey.
    
  6. Run the Backend Server cd api/server
    npm run start
    
  7. Run fronend client main directiory
    npm run start
    

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

Key Features:

  • Swipe and Match: Explore user profiles and indicate your interest with a simple swipe.
  • Real-time Chat: Connect with your training partner and plan workouts in a seamless messaging interface.
  • Gym Finder: Discover nearby gyms and fitness facilities based on your preferences.
  • Profile Customization: Showcase your fitness journey, interests, and goals through a personalized profile.
  • Privacy and Safety: We prioritize the privacy and safety of our users, ensuring a secure and enjoyable experience.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Contact

Khuzaima Rehman - LinkedIn - rehmankuhziama@gmail.com

Project Link: https://github.com/2022-csc-59866/AthleteLink

(back to top)