Woodwork Bike Park Management System

Report Bug · Request Feature

• About the Project
  • Screenshots
  • Dependencies
  • Features
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
• Roadmap
• License
• Contact
• Acknowledgements

• Authentication with Auth0
• Payments with Stripe

• React.js
• Material UI
• Sass
• Axios
• Auth0
• Stripe

• Node.js
• Express.js
• Knex.js

• MySQL

Color	Hex
Brand Color (light)	#D67A00
Brand Color (dark)	#EBA13F
Accent Color	#2e845d
Text Color (on dark)	#FFFFFF
Dark Background/Text Color (on white)	#000000

To run this project, you will need to add the following environment variables to your .env file. See env.sample file for more details.

API_SERVER_URL

AUTH0_DOMAIN

AUTH0_CLIENT_ID

AUTH0_CALLBACK_URL

AUTH0_LOGOUT_RETURN_URL

STRIPE_PUBLISHABLE_KEY

This project uses Node as package manager

See Node intallation instructions

 npm install -g npm

You will need accounts with Auth0 and Stripe to obtain your environment variables. Make sure that values provided in the Auth0/Stripe dashboards perfectly matches the values entered in your environment variables, or the app might not load (will return errors).

Get an account with Auth0

Get an account with Stripe

Make a top level project directory to hold the client and server-side code

 mkdir bike-park-project
 cd bike-park-project

Clone the client and server into the top level folder (two new folders will be created)

  git clone https://github.com/vpomerleau/bike-park-client.git

  git clone https://github.com/vpomerleau/bike-park-server.git

Go to the client directory

  cd bike-park-client

Install dependencies

  npm install

Set up the environment variables by creating a new .env file from .env.sample

Modify your .gitignore file to cover your needs - Toptal's gitignore.io is a useful tool to get a template by searching for package manager, OS, etc. For this project, recommended to at least include Node.

Run the client-side

  npm start

See Server-side readme for detailed server installation instructions.

• Proof of concept homepage
• Auth0 integration (dev mode)
• Stripe integration (dev mode)
• User profile updates
• User controlled booking management (incl. transferring tickets to other riders)
• Unit testing
• Phases 2 to 1,000 to build a full-featured bike park management system

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

Valerie Pomerleau - Twitter @PomerleauVal - LinkedIn @valeriepomerleau

(client): https://github.com/vpomerleau/bike-park-client

(server): https://github.com/vpomerleau/bike-park-server

Thank you to BrainStation for the knowledge, wisdom and support! In particular, I'd like to thank my May 2022 Web Dev cohort's educators (Daniil Molodkov, Michael Ti, Andrew Carolan) and TAs (Brishan King and Slobodan Zaja).

• Bike Lorem Ipsum from Bicycle Ipsum
• Logo design with Canva
• Mountain bike animation adapted from: Pure CSS bike animation
• Database schema planning with LucidChart
• Auth0 API docs
• Stripe API docs
• Stripe Dev Support on Discord
• Shields.io
• Awesome README template