This project was bootstrapped with Create React App.
This project serves as a demonstration for how to manage client side authentication via a server that manages JWT.
This project comes equipped with the following things:
- React
- Material-UI (component library for react)
- React-hook-form + yup (forms and schemas)
- axios (HTTP client)
- json-server (mock api)
- json-web-token (authentication)
- Cypress (testing suite)
After cloning repo and running npm install, you can start the application by running npm start. This should open the react app in the browser, if not - navigate to http://localhost:3000.
Upon launching the React app you will see a login form. The project comes preloaded with 1 user. You can use the username: admin and password: admin to login or you can register a new user by clicking the register button at bottom of login form which will redirect to http://localhost:3000/register.
Testing authentication is done via the home page http://localhost:3000.
After logging in, you will automatically be redirected here.
The endpoint that serves the company data requires the JWT to be present in the header of the request. So if you successfully query company data, you were authenticated!
The JWT is stored in browser local storage and the app is configured to pull it from there, meaning you can stay logged in across sessions assuming that the token has not expired (1 hour expiration).
Run the following command npm run cy this will start up the client and server just like npm start and will also open up cypress allowing you to select tests to run.
In the project directory, you can run:
Runs both the React app (in development mode) and json-server which is the mock API for authentication and CRUD operations.
Open http://localhost:3000 to view the app in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
The json-server will be running on http://localhost:3001.
Running this command is the same as npm start but this will also open up cypress to allow testing.
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.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify