Skip to content

Rodgers31/coder-heroes-fe

 
 

Repository files navigation

Basic SPA

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

CoderHeroes

You can find the deployed project at CoderHeroes.

Contributors

Chelsea Ceballos Jie Zhang Willis Li Bradly Lewis
Fernando Martinez Muhannad Bani Almarje Alejandro Vasquez Michael Guerrero
Kyle Andrews Rodgers Otieno Christine Nguyen Andrew Cummings
Joseph Brown


Tech stack

MIT React react-router-dom code style: prettier Less antd redux redux-thunk Axios Okta

  • Fork and clone the repo to install it as your own remote.
  • 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.

Key Features

  • Antdesign for component base
  • File scaffolding to organize pages and components
  • File scaffolding to organize styles
  • React router to handle project routing
  • Okta to handle user authentication
  • Less for global and component base styles
  • Redux for global state management

Front end deployed to heroku at coderheroes.

Back end built using:

  • Docker
  • Node.js
  • Express
  • Okta interaction

APIs

Authentication API here

For authentication we're hitting Okta. The Okta flow can be found here: OktaFlow. We're very early stages in using Okta. Right now users cannot self-register accounts need to be created on Okta by an administrator (from Lambda). Logging in does work with pre-defined accounts.

Payment API here

We we're planning on implementing Stripe for payments - however this is a future feature that we have not started implementing yet.

Misc API here

No misc API's currently being used.

Installation Instructions

  • git clone
  • npm install
  • npm start

Other Scripts

* 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

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

Worked as a front-end engineer with fellow students to deliver the interface for a non-profit called Coder Heroes.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 89.3%
  • Less 9.0%
  • HTML 1.7%