Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heblopez/singularity-pet
This is a web application built with React for a pet care company.
https://github.com/heblopez/singularity-pet
Last synced: 3 days ago
JSON representation
This is a web application built with React for a pet care company.
- Host: GitHub
- URL: https://github.com/heblopez/singularity-pet
- Owner: heblopez
- Created: 2024-11-14T17:20:57.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T23:47:02.000Z (3 months ago)
- Last Synced: 2024-12-11T19:14:50.815Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://singularity-pet.vercel.app
- Size: 1.53 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Singularity Pet Care
## 📃 Description
This is a web application built with **React**, **Vite**, and **TypeScript** for a pet care company. It has three main views: a home page, a login page and a not found page, in case the user tries to access a page that doesn't exist.
## 🚀 Demo
You can check out the demo of the application [here](https://singularity-pet.vercel.app/).
## 🌟 Features
- **Home Page**: Show all information about the Pet Care company, with sections like "How It Works", "Our Services", and "Testimonials".
- **Login Page**: Allow users to log in using the sample API: [ReqRes API](https://reqres.in/).
- **Not Found Page**: Show a 404 error page if the user tries to access a page that doesn't exist.
## 🛠️ Tech Stack
- **React**: JavaScript library for building user interfaces.
- **Vite**: Fast build tool that provides an efficient development environment.
- **TypeScript**: A superset of JavaScript that adds static types for improved development experience.
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development.
- **React Router**: For navigation between pages in the application.
## 📦 Installation
To install and run this application on your local machine, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/heblopez/singularity-pet.git
cd singularity-pet
```
2. **Install dependencies**:
```bash
npm install
```
3. **Start the development server**:
```bash
npm run dev
```
4. **Open your browser** and navigate to `http://localhost:5173` to see the application in action.
## 🖥️ Usage
- In the Home Page, users can see all information about the company, browsing through the different sections.
- In the Login Page, users can log in using the sample API: [ReqRes API](https://reqres.in/api/users). If the user is successfully logged in, they will be redirected to the home page. More information about the API can be found [here](https://publicapis.io/req-res-api).
- In the Not Found Page, users can see a 404 error page if they try to access a page that doesn't exist.
## 📜 Scripts in package.json
Here are the main scripts available in `package.json`:
- `dev`: Starts the development server with hot module replacement for a smooth development experience.
- `build`: Compiles the application for production, optimizing it for performance.
- `lint`: Checks the code for any linting errors.
## 🤝 Contributions
Contributions are welcome! If you would like to improve this project, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/new-feature`).
3. Make your changes and commit (`git commit -m 'Add new feature'`).
4. Push your changes (`git push origin feature/new-feature`).
5. Open a pull request.
## 📜 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## 📬 Contact
For more information or questions, you can reach me at [[email protected]](mailto:[email protected]).
---
Thank you for checking out this project! I hope you enjoy exploring the mobile device store. 🚀