Skip to content

BloomTech-Labs/bg-emotion-tracker-fe

Repository files navigation

Boys & Girls Club of Conejo Tracker Emotion Tracker

You can find the deployed project here.

Contributors

Labs 36

Ash Tilawat Michael Cavellier Robert Rodriguez Shawn Harrington George Hatzigeorgio Kayode Richards Fidan Novruzova
TPL TPM/Front-End Engineer Front-End Engineer Front-End Engineer/Design Lead Front-End Engineer Back-End Engineer Back-End Engineer


Labs 35

Joe Panetta Anthony Catanzariti Ash Tilawat Lucas Steinmacher Ethan Trevino Jackson Henry Fidan Novruzova
TPL TPL Front-End Engineer/Design Lead Front-End Engineer/Design Lead Back-End Engineer Back-End Engineer/Design Lead Front-End Engineer


Labs 34

André Jeon Chase Bianchi Donavyn Haley Isaac Pak Jiawei Wu Iaroslav Mokroguz Robert Garcia Samuel Perrin
TPL Full-Stack Engineer Front-End Engineer Front-End Engineer Back-End Engineer Front-End Engineer Design Lead, Front-End Engineer Back-End Engineer


Labs 33

Alexander Besse Donavyn Haley Jordan Hanson Jamie Jenks Sebastian Mendoza Iaroslav Mokroguz Jacob Olness Leah Tabush
TPL Front-End Engineer Back-End Engineer Back-End Engineer Co-Design Lead Front-End Engineer Back-End Engineer Co-Design Lead


MIT React code style: prettier

  • 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

  • Batch or individual generation of printable ID cards with QR Codes
  • Batch or individual import of staff, programs and members parsed from .csv files

Front end deployed to AWS

Back end built using:

Java Spring

  • point one
  • point two
  • point three

đŸš« List the rest of the back end end features and libraries in the same format as the framework above

APIs

Okta Authentication

The sign-in experience is one of the most important user experiences any app developer needs to consider. To provide a seamless and attractive, yet secure authentication experience is not a trivial task. Typically, the sign-in logic accompanies other features such as password reset and registration. More importantly, enhanced security in the form of strong and adaptive authentication during the sign-in process is often critical to many implementations.

Okta provides many options for developers to handle the authentication experience that are built on top of the underlying feature set in Okta. Password policies, strong and adaptive authentication policies, and password reset workflow can all be configured easily in the administrator UI. Many of these policies can also be controlled through Okta's API.

Okta provides OAuth 2.0 and OpenID Connect implementations, the Sign-In Widget, the Auth JS SDK, and the Authentication API.

Installation Instructions

npm i

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

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.

DON’T DELETE ANY QUESTION MARKS!

On the admin dashboard page and render alerts page, you will notice “.?” when handling context that is being used on the page. The question marks are important and they let the page render in the proper order. Without the question marks, the page will crash. When dealing with loading the context onto your page, having the question marks is useful in letting it load in first. For more info, checkout the webpage below: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining

Adding Graphs on the Admin Dashboard using Plotly.js:

The dashboard for both the admin and club director need to be populated. We began by setting one graph and the context necessary to create on the admin page. Please do your Plotly.js research! The object that is needed to make Plotly work is specific and needs attention to the smallest detail. You can use the ‘dt’ object on the admin page as a reference.

Tabs and Tab(common components):

Tabs are set up to take in a div that will populate the tab list.
When you want to use Tabs, you import Tabs from common. Under tabs, each div with a label prop represents a new tab. The label also equates to the title of the tab. So, you set what you want to label each tab to the label on the div. Like shown below:

Understanding Ant-Design:

Before beginning the project, learn about ant-design. All webpages are wrapped in a Layout, which is an Ant design feature. Take some time to understand what ant-design features are used when and how. Ant-design significantly impacts CSS and use the inspect tool on your browser to see the CSS ant-design is importing in and how it is affecting the page.

To-do’s:

Set up modal for both Club Director and Admin on RenderAlerts.js The CD page should have a resolve button and access to only their club’s alerts. Admin should have contact info for the club director’s phone and email. #Build out CD’s dashboard displaying only CD’s information. Leaderboard should not be visible to CD’s Alerts should be populated by activities of their club only and not Clubs as on the Admin page. Manage Members/ Programs should be of the Clubs only not all clubs and members.

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

  • A walk through of this app can be found here

  • Documentation is run on its own server by libzy

// from the root directory
cd docs
npm install
npm run start