Adopt Me React Hook TypeScript is a simple web application that allows users to view and adopt pets. The application is built using React, TypeScript, and Hooks.
This README will provide instructions on how to set up and run the application locally.
Before getting started, make sure you have the following installed on your system:
- Node.js (version 12 or higher)
- npm (version 6 or higher)
- Clone the repository to your local machine.
- Navigate to the root directory of the project in your terminal.
- Run npm install to install all project dependencies.
- In the root directory of the project, run npm start to start the development server.
- Open a web browser and go to http://localhost:3000 to view the application.
The application allows users to:
- View a list of pets available for adoption
- Filter pets by animal type and location
- View details of a specific pet
- Adopt a pet by filling out an adoption form
The application is built using the following technologies:
- React: A JavaScript library for building user interfaces
- TypeScript: A statically typed superset of JavaScript
- Hooks: A feature introduced in React 16.8 that allows you to use state and other React features without writing a class
- React Router: A library that provides routing capabilities to a React application
- ESLint: A tool for identifying and reporting on patterns found in JavaScript code
- Prettier: A code formatter that enforces a consistent code style
The application is organized into several directories and files:
- public/: Contains static assets that are served to the client.
- src/: Contains the application's source code.
- components/: Contains reusable UI components used throughout the application.
- hooks/: Contains custom hooks used throughout the application.
- pages/: Contains the application's main pages.
- redux/: Contains the Redux store configuration and related files.
- types/: Contains TypeScript type definitions used throughout the application.
- ndex.tsx: The entry point of the application.
- package.json: Contains metadata about the project and its dependencies.
- tsconfig.json: Contains TypeScript configuration options.
Contributions to the project are welcome! If you find a bug or would like to suggest a feature, please open an issue on the project's GitHub repository.
This project is licensed under the MIT License. See the LICENSE file for more information.