For the steps on how to work with this repository please see here
You can find the deployed project at CoderHeroes.
 |
 |
 |
 |
|---|---|---|---|
| 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 |
- Fork and clone the repo to install it as your own remote.
- note please be sure to set your remote for this repo to point to your Labs Team Front End Repository.
- run:
npm installto download all dependencies. - run:
npm startto start your local development server.
When using Okta for authentication, the app will need to run locally on port 3000.
- 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
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.
We we're planning on implementing Stripe for payments - however this is a future feature that we have not started implementing yet.
No misc API's currently being used.
- git clone
- npm install
- npm start
* 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
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.
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.
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.
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.
- 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.
See Backend Documentation for details on the backend of our project.
- You will be using jest along side with React Testing Library to test your application.
- Please put all of your tests for your code in
__tests__folder. - You should get into the habit of ensuring that you have coverage for your code before submitting a pull-request.
- When writing tests run the command:
cd intothe root of this directorynpm testto run your test suite- if you're prompted select
ato run tests in watch mode. This will re-run your test suite when you save any file in your application.
- if you're prompted select
- In your terminal you will see a test runner that looks something like this:
- When you're not actively writing tests its best to close that terminal window so that you don't keep running tests when your files are saved.
💡 Code coverage should be a good goal to have and a good starting place. But every application will be different.
-
Kent Dodds put it nicely. Strive for solid coverage as we strive to hand you over well-tested code in which we have extreme confidence.
-
To run a coverage report for your application simply run
npm run coverage. -
You should see a print out in your console that looks like this:
Components in folder src/pages/ExampleDataViz represent a pattern that you can use when working as a part of a Hybrid Team. When working with Data Scientists you'll need to ensure that you communicate as often as you possibly can with that team. They will be doing hard work using Plotly to ensure that the data they're working with is charted out in a visually appealing way, however you'll need to work with them to integrate their work into the app.
The RenderDataViz.js file demonstrates how you can pull in data from an external API, set that data on state, and then pass that data down to a <Plot /> component. In this case, the URL for the plot component is the only prop that will be needed to send off the API call and subsequently mount the Plot components w/ the appropriate data. Be sure to handle your errors nicely.
- The
LoginContainer.jsfile insrc/pages/Loginincludes a widget that is provided to us by Okta. - This widget is the key to
user authentication and managementwithin your application. - You don't have to manage ANY users because we're letting Okta do this for us :)
- This component is heavily documented with comments but it'd be REALLY good to read through the docs here to get a good understanding of the configuration we're doing with the widget itself.
- You'll also want to learn a bit about how to style this widget to meet your app's concerns.
Utilsdirectory is for any of the business logic that your application may need to use.- Simple one-off helper functions that you may need can be defined in this directory.
- Any reusable logic or handlers or config files can also be used here.
- REMINDER do not check any sensitive information into git
Loom[https://www.loom.com/share/e304d66df57a42b4871ed82a2aa98dd1]
[Loom] https://www.loom.com/share/686ebc35d65b45d9b2e3c63ef7848736
[Loom] https://www.loom.com/share/1fd02cd49ea4481ebb4e3e6829af323b
Loom [https://www.loom.com/share/b096caec05d64723973075cb4d6bbd00]
Loom[https://www.loom.com/share/abb423fc7e5444a3b7f01baca244b3dd]
Loom[https://www.loom.com/share/4c5f90178f17417aa206f2319bb16a39]
Loom[https://www.loom.com/share/5250dabcfb8f40d6bae9b363118fc910]
Loom[https://www.loom.com/share/20a4917f86de4cbd9499f41d34061706] (part 1) Loom[https://www.loom.com/share/b6648c95d4b74b3aa2e3b153f3a410fe] (part 2)
Loom[https://www.loom.com/share/ad3fcdce651c4e8381781df08e40d7b1] (part 1) Loom[https://www.loom.com/share/8b94d91bcacc47f7ad082d26eab1f94a] (part 2) Loom[https://www.loom.com/share/689ff99c6838454483724f7f281f8241] (part 3) Loom[https://www.loom.com/share/42e6893185c44a5cbd64b3ba3a90faff] (part 4) Loom[https://www.loom.com/share/d0f2ee9de7e6439280c826560c36393b] (part 5) Loom[https://www.loom.com/share/a47320e57c9f46f88e6ee14d5a8563bb] (part 6) Loom[https://www.loom.com/share/70db70523b7e45a0852c6f39eb29261e] (part 7) Loom[https://www.loom.com/share/ba15e1a16e174d25a39db4ee01a013fc] (part 8) Loom[https://www.loom.com/share/a6eb1260c8ce45adad1d38a4c9b42686] (part 9)