Skip to content

BloomTech-Labs/Labs26-Bridgegood-FE

Repository files navigation

BRIDGEGOOD

BridgeGood is an organization that mentors aspiring designers in Oakland. They recently received a workspace for students to work in. We will be building a reservation and donation system for that workspace. Web students will focus on two user types: users and admin. You will be given hi-fi wireframes and be expected to ship to spec.

You can find the deployed project at BRIDGEGOOD.dev.

Contributors

Ana Carrillo Alexander Besse Anthony Koharian Drake Alia Gregory Hawman Yasir Haymm


Project Overview

Product Demo Video on Youtube

Labs 26 Trello Board

  • Authentication
  • Reservation system
  • Donation
  • Admin dashboard

Tech Stack

MIT React code style: prettier

🚫 more info on using badges [here](https://github.com/badges/shields)

Front end deployed to AWS Amplify built using:

  • React
  • Redux
  • Ant Design
  • Venmo

Back end built using:

  • Node.js
  • Knex/Express
  • PostgreSQL
  • Swagger-UI

Product Diagram and Engineering Architecture: click here

Database Schema: click here

APIs

Okta Authentication API

  • Okta is the only approved identity and access management company per the Lambda School Engineering Standards
  • Okta is a trusted service that has been in buisness since 2009
  • Okta allows developers to build identity controls into applications, website web services and devices

Venmo Payment API

  • Venmo is a mobile payment service owned by PayPal. Venmo account holders can transfer funds to others via a mobile phone app; both the sender and receiver have to live in the U.S.

Installation Instructions

  • Fork and clone the repo to install it as your own remote.
  • Set you environment variables
  • run: npm install to download all dependencies.
  • run: npm start to start your local development server.

When using Okta for authentication, the app will need to run locally on port 3000.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

REACT_APP_CLIENT_ID=example
REACT_APP_OKTA_ISSUER_URI="https://example-882474.okta.com"
REACT_APP_API_URI=http://localhost:3000
REACT_APP_VENMO_CLIENT_ID=example
REACT_APP_BRAINTREE_TOKENIZATION_KEY=example
REACT_APP_CUSTOM_ENV=dev

The variables REACT_APP_VENMO_CLIENT_ID and REACT_APP_BRAINTREE_TOKENIZATION_KEY are necessary for connecting to Venmo through the Braintree API.

The REACT_APP_CUSTOM_ENV variable is used to configure app behavior based on environment. For example, setting it to dev will enable the Redux logger

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

Basic SPA

For steps on how to work with this repository please see here

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Documentation

See Backend Documentation for details on the backend of our project.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published