Skip to content

ft-anywhere-fitness-7/back-end

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
api
api
 
 
.eslintrc.json
.eslintrc.json
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
index.js
index.js
 
 
jest.config.js
jest.config.js
 
 
knexfile.js
knexfile.js
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

Repository files navigation

Anywhere Fitness API

https://ft-anywherefitness-7.herokuapp.com/

---------- REGISTER / LOGIN ----------

Dummy Login Info

Usernames/Passwords 
[
  {
    "user_id": 1,
    "username": "tom",
    "password": "password",
    "role_type": "instructor"
  },
  {
    "user_id": 2,
    "username": "jerry",
    "password": "password",
    "role_type": "instructor"
  },
  {
    "user_id": 3,
    "username": "garfield",
    "password": "password",
    "role_type": "client"
  },
  {
    "user_id": 4,
    "username": "odie",
    "password": "password",
    "role_type": "client"
  }
]

[POST] /api/auth/register

  • Register a new user
    • username required (must be between 3 and 30 characters)
    • password required (must be between 5 and 200 characters)
    • role required (must be between 'client' or 'instructor', insructor requires auth code)

What you send:

{
  "username": "SampleUser",
  "password": "abc123",
  "role_type": "client"
}
{
  "username": "SampleUser",
  "password": "abc123",
  "role_type": "instructor",
  "auth_code": "auth_instructor_123"
}

What you receive:

{
  "message": "Account successfully created. Please login.",
  "newUser": {
    "user_id": 15,
    "username": "SampleUser",
    "role_type": "instructor"
  }
}

[POST] /api/auth/login

  • Login
    • username and password required
    • provides a newly created token

What you send:

{
  "username": "SampleUser",
  "password": "abc123"
}

What you receive:

{
  "message": "welcome, SampleUser",
  "role": "instructor",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0Ijo1LCJ1c2VybmFtZSI6Ik5ld1VzZXIiLCJpYXQiOjE2MjcyNjY4MDYsImV4cCI6MTYyNzM1MzIwNn0.J1dFd3ghUPYVTodsaAU3Bg2RRcmYM_1oOe-96nvLLUg"
}

[GET] /api/users/

RESTRICTED ENDPOINT

  • Get an array of users
    • requires valid token in authorization header to access

What you receive:

[
  {
    "user_id": 1,
    "username": "tom",
    "role_type": "instructor"
  },
  {
    "user_id": 2,
    "username": "jerry",
    "role_type": "instructor"
  },
  {
    "user_id": 3,
    "username": "garfield",
    "role_type": "client"
  },
  {
    "user_id": 4,
    "username": "odie",
    "role_type": "client"
  }
]

[GET] /api/user/

RESTRICTED ENDPOINT

  • Get information on a specific user
    • requires valid token in authorization header to access

What you receive:

{
  "user_id": 3,
  "username": "garfield",
  "role_type": "client"
}

---------- CLASSES ----------

[GET] /api/classes

RESTRICTED ENDPOINT

  • Get an array of all classes you can sing up for
    • requires valid token in authorization header to access

What you receive:

[
  {
    "class_id": 1,
    "class_name": "Morning Zen",
    "class_duration": "1 hour",
    "max_class_size": 15,
    "class_date": "2021-11-17T05:00:00.000Z",
    "start_time": "08:00:00",
    "class_location": "Central Park",
    "instructor": "tom",
    "intensity_level": "beginner",
    "type_description": "yoga",
    "number_registered": 2
  },
  {
    "class_id": 2,
    "class_name": "Boxing Basics",
    "class_duration": "45 min",
    "max_class_size": 12,
    "class_date": "2021-12-22T05:00:00.000Z",
    "start_time": "10:30:00",
    "class_location": "YMCA",
    "instructor": "jerry",
    "intensity_level": "beginner",
    "type_description": "boxing",
    "number_registered": 1
  },
  {
    "class_id": 3,
    "class_name": "Sunday Spinning",
    "class_duration": "1.5 hours",
    "max_class_size": 25,
    "class_date": "2021-11-19T05:00:00.000Z",
    "start_time": "19:00:00",
    "class_location": "Gym Z",
    "instructor": "tom",
    "intensity_level": "advanced",
    "type_description": "cycling",
    "number_registered": 2
  },
  {
    "class_id": 4,
    "class_name": "Water Aerobics",
    "class_duration": "2 hours",
    "max_class_size": 10,
    "class_date": "2022-01-07T05:00:00.000Z",
    "start_time": "16:45:00",
    "class_location": "Community Pool",
    "instructor": "jerry",
    "intensity_level": "intermediate",
    "type_description": "swimming",
    "number_registered": 1
  },
  {
    "class_id": 5,
    "class_name": "Bikram Yoga",
    "class_duration": "30 min",
    "max_class_size": 20,
    "class_date": "2022-02-08T05:00:00.000Z",
    "start_time": "18:30:00",
    "class_location": "Gym X",
    "instructor": "jerry",
    "intensity_level": "advanced",
    "type_description": "yoga",
    "number_registered": 0
  }
]

[POST] /api/classes/add

RESTRICTED ENDPOINT

  • Add information for a new class
    • requires valid token in authorization header to access

What you send:

{
  "class_name": "Weights",
  "class_duration": "1 Hour",
  "max_class_size": 20,
  "class_date": "2021-11-17",
  "start_time": "08:00:00",
  "class_location": "Weights Gym",
  "class_instructor": 1,
  "intensity_id": 1,
  "type_id": 1
}

[GET] /api/classes/:class_id

RESTRICTED ENDPOINT

  • Get information for a specific class
    • requires valid token in authorization header to access
    • (example uses "1" for :class_id in URL)

What you receive:

{
  "class_id": 1,
  "class_name": "Morning Zen",
  "class_duration": "1 hour",
  "max_class_size": 15,
  "class_date": "2021-11-17T05:00:00.000Z",
  "start_time": "08:00:00",
  "class_location": "Central Park",
  "instructor": "tom",
  "intensity_level": "beginner",
  "type_description": "yoga",
  "number_registered": 2
}

[GET] /api/classes/:user_id/attending

RESTRICTED ENDPOINT

  • Get an array of classes a specific user is registered for
    • requires valid token in authorization header to access
  • (example uses "4" for :user_id in URL) What you receive:
[
  {
    "class_id": 1,
    "class_name": "Morning Zen",
    "class_duration": "1 hour",
    "max_class_size": 15,
    "class_date": "2021-11-17T05:00:00.000Z",
    "start_time": "08:00:00",
    "class_location": "Central Park",
    "instructor": "tom",
    "intensity_level": "beginner",
    "type_description": "yoga"
  },
  {
    "class_id": 2,
    "class_name": "Boxing Basics",
    "class_duration": "45 min",
    "max_class_size": 12,
    "class_date": "2021-12-22T05:00:00.000Z",
    "start_time": "10:30:00",
    "class_location": "YMCA",
    "instructor": "jerry",
    "intensity_level": "beginner",
    "type_description": "boxing"
  }
]

[GET] /api/classes/:user_id/teaching

RESTRICTED ENDPOINT

  • Get an array of classes a specific instructor is teaching
    • requires valid token in authorization header to access
  • (example uses "2" for :user_id in URL) What you receive:
[
  {
    "class_id": 2,
    "class_name": "Boxing Basics",
    "class_duration": "45 min",
    "max_class_size": 12,
    "class_date": "2021-12-22T05:00:00.000Z",
    "start_time": "10:30:00",
    "class_location": "YMCA",
    "intensity_level": "beginner",
    "type_description": "boxing",
    "number_registered": 1
  },
  {
    "class_id": 4,
    "class_name": "Water Aerobics",
    "class_duration": "2 hours",
    "max_class_size": 10,
    "class_date": "2022-01-07T05:00:00.000Z",
    "start_time": "16:45:00",
    "class_location": "Community Pool",
    "intensity_level": "intermediate",
    "type_description": "swimming",
    "number_registered": 1
  },
  {
    "class_id": 5,
    "class_name": "Bikram Yoga",
    "class_duration": "30 min",
    "max_class_size": 20,
    "class_date": "2022-02-08T05:00:00.000Z",
    "start_time": "18:30:00",
    "class_location": "Gym X",
    "intensity_level": "advanced",
    "type_description": "yoga",
    "number_registered": 0
  }
]

[POST] /api/classes/signup

RESTRICTED ENDPOINT

  • User can register for a specific class
    • requires valid token in authorization header to access

What you send:

{
  "user_id": 3,
  "class_id": 4
}

What you receive:

{
    "class_id": 4,
    "class_name": "Water Aerobics",
    "class_duration": "2 hours",
    "max_class_size": 10,
    "class_date": "2022-01-07T05:00:00.000Z",
    "start_time": "16:45:00",
    "class_location": "Community Pool",
    "instructor": "jerry",
    "intensity_level": "intermediate",
    "type_description": "swimming",
    "number_registered": 6
}

[PUT] /api/classes/:id

RESTRICTED ENDPOINT

  • where :id is class_id (example uses "2" for :id in URL)

  • Edits given values of a specific class

    • requires valid token in authorization header to access

    What you send:

{
  "location": "Gym Z"
}

What you receive:

{
    "class_id": 2,
    "class_name": "Boxing Basics",
    "class_duration": "45 min",
    "max_class_size": 12,
    "class_date": "2021-12-22T05:00:00.000Z",
    "start_time": "10:30:00",
    "class_location": "Gym Z",
    "instructor": "jerry",
    "intensity_level": "beginner",
    "type_description": "boxing",
    "number_registered": 1
}

[DELETE] /api/classes/:class_id

RESTRICTED ENDPOINT

  • where :class_id is class_id (example uses "2" for :id in URL)

  • Deletes specific class

    • requires valid token in authorization header to access

What you receive:

{
    "message": "Boxing Basics has been deleted successfully"
}

About

A RESTful API built with PostgreSQL, Node.js, Knex, and Express to create a database for a fitness application

ft-anywherefitness-7.herokuapp.com/

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages