Skip to content

BloomTech-Labs/quality-hub-core-fe

Repository files navigation

QualityHub Core

You can find the deployed project at https://qhubfe.herokuapp.com/. Project including ResumeQ is deployed at https://qualityhub19.netlify.com/.

Contributors

Julie Antonio Jordan Doan Nicholas Gonzalez Jonathan Ho Justin McCutcheon
Krishan Nattar Ryan Ziegenfus Yuka Okamoto Livingston Reggie Sackey-Addo Oscar Ortiz
Zac Higgins Hugo Oliveira Joe Oliver Jaytee Padilla Ryan Renteria
Will VanOrder

ResumeQ Contributors

Robert Benavidez Adam Payne Taran Neeld Jonathan Mendoza Aaron Clark



Maintainability

Test Coverage

MIT React

Netlify Status code style: prettier

🚫 more info on using badges here


Project Overview

Trello Board

Product Vision Document

UX Design files

QualityHub creates the fastest way to have anything assessed for its quality in a measurable and meaningful way while simultaneously providing the easiest way to monetize niche quality assessment skills. QualityHub Core provides a dashboard that allows users to see the available quality assessment services (InterviewQ, ResumeQ, etc.)

Key Features

  • Central platform for registration and login for QualityHub services
  • Authorization and Authentication
  • Access to all QualityHub services
  • Dashboard for user to see summaries from various QualityHub services
  • Update profile information functionality
  • Update profile picture functionality
  • Delete profile functionality

Tech Stack

Front-end built using:

ReactJS

  • Fast, scalable, simple
  • Data and state updating without reloading page
  • Reusable UI components

graphql

  • Get multiple resources in a single request
  • More efficient data loading than REST architecture
  • No over- or underfetching
  • Allows for rapid product iterations on Front-end (useful for different QualityHub services)
  • Allows for front-end and back-end teams to work independently from each other (useful for teams working on future QualityHub services)

Apollo Client

  • State management for GraphQL queries
  • Declarative data fetching
  • Caches data to manage application state with zero configuration
  • Combines local and remote data

axios

  • Accesses Cloudinary REST API endpoint for profile pictures

dotenv

  • Loads environmental variables from a .env file into process.env

node-sass

  • Allows for component styling flexibility

React Router

  • Allows for declarative routing

yup

  • Allows for schema validation on forms

Front end deployed to Netlify


Back-end Gateway built using:

Apollo Gateway

  • Implement's Apollo Server's federated gateway
  • Implements services from multiple GraphQL APIs into a single GraphQL endpoint
  • Allows for backends for multiple QualityHub services (e.g., Core, InterviewQ, ResumeQ) to be built separately

Apollo Server

  • Builds production-ready, self-documenting API for GraphQL clients using data from multiple sources

graphql


Core Back-end built using:

Apollo Federation

  • Implements a single data graph across multiple services (conducive for QualityHub services)
  • Allows clients to fetch data from any number of sources simultaneously
  • Divides data graph's implementation across distinct, composable services
  • Allows QualityHub to represent data graph as collection of separately maintained GraphQL services

graphql-yoga

  • Runs GraphQL server
  • Provides interactive GraphQL IDE
  • Allows for Express middleware
  • Built on Express and Apollo Server

Prisma

  • Builds GraphQL server
  • Replaces traditional ORMs
  • Simplifies database access
  • Declarative data modeling
  • Allows for visual data management

Express

  • Server framework for building web applications

Apollo Server

bcryptjs

  • Securely hashes and checks passwords

jsonwebtoken

  • Creates and transmits JSON-based access tokens

dotenv

  • Loads environmental variables from a .env file into process.env

APIs

2️⃣ Authentication API here

🚫Replace text below with a description of the API

Water's like me. It's laaazy ... Boy, it always looks for the easiest way to do things A little happy sunlight shining through there. Let all these little things happen. Don't fight them. Learn to use them. Even the worst thing we can do here is good.

2️⃣ Payment API here

🚫Replace text below with a description of the API

This is the way you take out your flustrations. Get away from those little Christmas tree things we used to make in school. Isn't it fantastic that you can change your mind and create all these happy things? Everything's not great in life, but we can still find beauty in it.

3️⃣ Misc API here

🚫Replace text below with a description of the API

You can do anything your heart can imagine. In life you need colors. This is where you take out all your hostilities and frustrations. It's better than kicking the puppy dog around and all that so. I'm sort of a softy, I couldn't shoot Bambi except with a camera. Trees get lonely too, so we'll give him a little friend. We'll lay all these little funky little things in there.

3️⃣ Misc API here

🚫Replace text below with a description of the API

When you do it your way you can go anywhere you choose. Let your heart take you to wherever you want to be. If I paint something, I don't want to have to explain what it is. A tree needs to be your friend if you're going to paint him. That's a son of a gun of a cloud. Even the worst thing we can do here is good.

3️⃣ Misc API here

🚫Replace text below with a description of the API

Volunteering your time; it pays you and your whole community fantastic dividends. Maybe there's a happy little waterfall happening over here. You can spend all day playing with mountains. We don't have to be committed. We are just playing here. You have freedom here. The only guide is your heart. It's cold, but it's beautiful.

3️⃣ 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:

🚫These are just examples, replace them with the specifics for your app

*  REACT_APP_apiKey - this is your Google API key, which can be generated in the Google Cloud Console
*  REACT_APP_authDomain - when you set up your Firebase project, this information will be in the dashboard
*  REACT_APP_databaseURL - in the Firebase dashboard
*  REACT_APP_projectID - in the Firebase dashboard
*  REACT_APP_storageBucket - in the Firebase dashboard
*  REACT_APP_messagingSenderId - in the Firebase dashboard
*  REACT_APP_stripe_API - this is your public Stripe API key, generated in the Stripe dashboard
*  REACT_APP_backendURL - optional for your local development server
*  REACT_APP_clientid - this is the Stripe_connect clientID, generated in Stripe_connect settings
*  REACT_APP_stripe_plan - this is the ID for a second Stripe subscription plan, generated under Stripe products

5️⃣ Content Licenses

🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table

Image Filename Source / Creator License
doodles.png Nicole Bennett Creative Commons
rings.svg Sam Herbert MIT

4️⃣ Testing

Jest

React Testing Library

@apollo/react-testing

Installation Instructions

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Other Scripts

🚫replace these examples with your own

* typecheck - runs the TypeScript compiler
* 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.

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

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • 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.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See [Backend Documentation](🚫link to your backend readme here) for details on the backend of our project.

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 19