Welcome to the University Management System frontend! Built using React and TypeScript, this system offers a beautiful, intuitive, and powerful interface for managing student data, course registrations, and more. It also boasts solid testing with Jest and Cypress to ensure everything works flawlessly.
- ⚡️ React with TypeScript: Combining React's dynamic capabilities with TypeScript's type safety for a seamless developer experience.
- 🧩 Modular Architecture: A component-based design that ensures maintainability and scalability as the app grows.
- 📦 Efficient State Management: Effortlessly handles app state using tools like [Redux/Context API/etc.].
- 🔗 Smooth API Integration: Easily communicates with your backend to handle data synchronization and fetching.
- 📱 Responsive Design: A stunning and adaptive interface that looks great on all devices.
- 🔍 High Test Coverage: The project includes robust testing using Jest and Cypress to ensure everything functions as expected. Here's the test coverage summary:
| Test Framework | Test Coverage | Passed | Failed | Total |
|---|---|---|---|---|
| Jest | 100% (Statements) | 7/7 | 0/7 | 7 |
| Cypress | 100% (E2E Tests) | 3/3 | 0/3 | 3 |
- 💡 Detailed Coverage: All files in the project are thoroughly tested, including key files like Auth.State.Slice.ts and View.State.Slice.ts. Our code coverage is robust, with high uptime for line, function, and branch coverage across important files.
Before you dive in, ensure you have the following installed:
- Node.js: Version 18.0.0 or higher 🌱
- npm: Version 8.0.0 or higher 🛠️
-
Clone the Repository:
git clone https://github.com/Swiatlon/University-FN
-
Navigate to Your Project Directory:
cd University-FN -
Install Dependencies:
npm install
-
💻 Development Mode: Start the app with live reloads to enjoy the development experience!
npm run dev
-
🚀 Production Build: When you're ready to deploy, build the app for production:
npm run build
Your production-ready build will be in the build directory.
-
Jest Tests: Run unit and integration tests with Jest:
npm run test -
Cypress Tests: Run end-to-end tests with Cypress:
npm run cypress
This project is open-source and licensed under the MIT License. Check out the full details in the LICENSE file.
If you have any questions or feedback, feel free to reach out:
- Email: [your email address] 📧
- Open an issue on GitHub Issues 💬
Happy coding! ✨