This project was developed as part of a coding challenge. It is bootstrapped with Create React App, and customized to use TypeScript and Material-UI 4 for a robust and scalable frontend development experience.
Time Taken for Completion This project was completed in approximately 6 hours. This time estimate includes all aspects of the development process, such as planning, coding, debugging, and testing.
Getting Started These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites Before running the project, make sure you have Yarn installed on your system. If you do not have Yarn installed, you can follow the instructions at Yarn Installation Guide.
Installing To get the development environment running:
Clone the repo to your local machine. Navigate to the project directory. Run yarn install to install all dependencies. 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 your browser.
The page will automatically reload if you make changes to the code. You will also see any lint errors in the console.
yarn build Builds the app for production to the build folder. It correctly bundles React in production mode, optimizes the build for the best performance, and includes TypeScript type-checking.
The build is minified, and the filenames include the hashes. Your app is ready to be deployed!
yarn test Currently, there are no unit tests available for this project. We plan to add them in future updates to improve the reliability and maintainability of the code.
Styling with Material-UI 4 This project uses Material-UI 4 for styling. Material-UI is a popular React UI framework that offers a comprehensive suite of UI tools to enhance the user interface of your React apps.
Refer to the Material-UI 4 Documentation for more details on using this framework.
TypeScript TypeScript is used in this project to ensure type safety and improve the development experience with strong typing and object-oriented programming features.
Refer to the TypeScript Documentation for more details on using TypeScript in React applications.
Deployment For more information on deployment, refer to the section about deployment in the Create React App documentation.
Contributing Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
License This project is licensed under the MIT License - see the LICENSE.md file for details. git