A single page web application for viewing, adding, and updating employee information in the Rivet Employee Directory. A deployed build can be viewed here.
The frontend codebase is built with React using Redux and the reducer pattern for state management. Development and production builds give you access to Redux logging and development tools for tracking the dispatching and resolution of actions.
Form state for adding and editing profiles is managed by the Formik library and validated with Yup.
Asychronous calls to the employee directory API are handled with action creators defined in /src/actions/profileActions using an instance of axios defined in /utils/axiosWithAuth that adds the necessary authorization headers and base URL to all requests.
If there is an error response from the server, it will be rendered in an ErrorModal component with the HTTP status, status text, and error message if available.
The profile form validation schema should prevent all form submission input errors, which makes it difficult to test the ErrorModal. The form validation for email is therefore currently disabled, so you can test ErrorModal by omitting an email address when submitting a profile form.
The frontend is styled with the Bulma CSS framework and animated with React-Spring animation library to minimize bundle size and maximize developer options for future styling decisions.
Bulma is compiled with a node-sass developer dependency to allow the customization of theme variables and the injection of custom classes.
Theme variables are defined in the /src/styles directory. Global classes or styles are defined in /src/App.scss.
Component specific files are contained within a .scss file in their respective component directory
Hyphenated classes such as is-size-6 in the React components are bulma native CSS classes and are documented in the Bulma Documentation. Underscored classes such as spinner_center are custom CSS classes built for this application.
Jest is use for snapshot, unit, and integration tests. The Testing-Library/React library is used to help test React components. It includes many utilities that simplify setting up and testing React components. @testing-library/jest-dom provides additional assertion methods. @testing-library/user-event has utilities for simulating user events such as clicking on a button.
The @testing-library/react library is re-exported from /utils/testUtils.js with a custom render method that wraps tested components in the redux store and react-router providers.
This project was bootstrapped with Create React App and uses their utilities for building development and production deployments. In the project directory, you can run:
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.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
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.
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.
You can learn more in the Create React App documentation.