Skip to content

chardbres/smash-factor-api

Repository files navigation

Smash Factor API: back-end API for the Smash Factor app!

Setup Steps

  1. Fork and clone this repository.
  2. Run npm install to install all dependencies.
  3. Use npm run server to spin up the local server on default port 4741.

Links to relevant repositories and deployed sites

Links to Entity Resource Diagram (ERD)

Description

This is the repository for the back-end of the Smash Factor client site, built with Expres and hosted on Herokut. Smash factor is an application built with React, for users to track their golf clubs by type, brand, loft, and stiffness, and the quality of their strokes with each.

Technologies Unsed

  • Express/MongoDB (JavaScript): all back-end API functionality
  • Git/Github: version control
  • cURL/Postman: testing of API routes independent of front-end client functionality
  • Node.js/npm: necessary dependency packages for functionality
  • Markdown: README and/or other documentation

Timeline

  • (2019-12-02): successfully deployed basic API template to heroku for testing purposes.
  • (2019-12-03): created models for golf clubs and shots, and routes for clubs. Confirmed index, create, delete, and update functionality with Postman.
  • (2019-12-04): completed all routes in club_routes.js.
  • (2019-12-05): created a model and routes for shots related to each club, but could not properly deploy.

Unsolved Problems / Wish-List

  • Complete all functionality to add shot-tracking functionality to each club: models and routes

Catalog of Expected routes

Verb Action URI Pattern
POST Sign-up new user /sign-up
POST Sign-in user /sign-in
PATCH Change user password /change-password
DELETE Sign-out user /sign-out
GET Index list of clubs /clubs
GET Read a single club /clubs/:id
POST Create a new club /clubs
PATCH Update a club /clubs/:id
DELETE Delete a club /clubs/:id

About

Express API for Smash Factor app!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published