Live Site

ATHLETE 101

Table of Contents

1. About The Project
   • Technical Stack
   • Introduction
   • MVP
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. API Frontend
5. API Backend
6. Redux State Structure

About The Project

*Easy sign up page. *Login options with demo login *Renders all the workout plans. *My profile page with my workout plans and following workout plans. *View work out plan. *Can create workout plan.

Technical Stack

• The project runs a React/Redux frontend.
• Material-UI
• The Backend uses Express and S3 with postgreSQL.

introduction

Athlete101 is a online platform that allows users to create workout plans. User can simply create workout with given exercises and follow others. In My101, users can manage their plans and following plans.

MVP

the MVP for this website encompasses the following:

1. Login/Sign-up
   1. Users can login as a demo account.
   2. Users can create account in sign-up page.
2. Main Browser
   1. Show all the plans users created including others users.
   2. each card shows users's name, avator, and short description.
   3. users can click view detail.
   4. users can follow workout plans
3. Plan
   1. Show the detail of the plan along with associating exercises.
   2. Can create and delete workout plans that belowing to the user.
   3. Can floow other user's workout plan and navigate to that from my profile.
4. Review
   1. Can submit review with rating.

Getting Started

---

To get a local copy up and running follow these simple steps.

Prerequisites

Express, react, s3...

Installation

1. Clone the repo

   git clone https://github.com/southpeter77/athlete-101
   git clone https://github.com/southpeter77/backEnd101

2. Install NPM packages

   npm install

3. Create your postgres database and connect it to the app.

4. run backend at the root level

   npm start

5. cd into Client directory to run frontend

   npm start

6. browser will open automatically.

Usage

---

One User can have an amazing workout plan that should be shared with others. Using this platform, anyone can join and create their own workout plan, follow other's and review each others.

API Frontend

---

Path	HTTP Verb	Meaning
/	GET	Login
/signup	GET	Sign up page
/plan/:id	GET	Show all the exercise belong to this plan
/myProfile	GET	Show my profile
/myProfile/createPlan	GET	Create workout Plans

---

API Backend

---

Path	HTTP Verb	Meaning
/api/user/	PUT	Log In
/api/user/:id	GET	Get information of this User
/api/user/signup	POST	Create User's account and sign in
/api/review/	PUT	Get reviews for certain Plan
/api/review/submit	POST	Create review for the plan
/api/profile/aboutme	PUT	Get information about me
/api/plan/:id	GET	Get information about the Plan
/api/plan/create	POST	Create Plan
/api/plan/delete	DELETE	Delete Plan
/api/plan/top	GET	Get top Plans
/api/plan/myplan	GET	Get my Plans
/api/images/all	GET	Get all the images
/api/images/upload	PUT	Upload images
/api/exercise/all	GET	get all the exercises
/api/exercise/create	POST	Create an exercise
/api/exercise/delete	DELETE	Delete an exercise

Redux State Structure

state={
    user,
    plan,
    profile,
    category,
    exercise,
    exerciseFormDetail,
    review,
    following,
    images  
}