This repository contains the frontend part of a Biometric Attendance System. The system is designed to work with a backend built using Django and a MySQL database. It provides a user-friendly interface for employees to check in and out using biometric data.
- User authentication and authorization.
- User-friendly dashboard for employees.
- Real-time attendance tracking.
- Integration with the Django backend for data storage and management.
This project relies on the following major dependencies:
- React (v18.2.0) - JavaScript library for building user interfaces.
- React DOM (v18.2.0) - React library for interacting with the DOM.
- React Router DOM (v6.15.0) - Routing library for React applications.
- Bootstrap (v5.3.1) - Front-end framework for responsive web design.
- crypto-browserify (v3.12.0) - Cryptographic library for browser environments.
- web-vitals (v2.1.4) - Library for measuring web vitals and performance metrics.
To set up this project locally, follow these steps:
-
Clone this repository to your local machine.
git clone https://github.com/your-username/basfrontend.git
-
Navigate to the project directory.
cd biometric-attendance-frontend
-
Install the project dependencies using npm.
npm install
-
Start the development server.
npm start
-
Open your web browser and access the development server at http://localhost:3000.
Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:
- Fork the repository on GitHub.
- Create a new branch with a descriptive name for your feature or bug fix.
- Make your changes and commit them with clear and concise commit messages.
- Push your branch to your fork.
- Create a pull request to the
main
branch of this repository.
This project is licensed under the GNU License - see the LICENSE.md file for details.
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may 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.
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