PetHaven

PetHaven is a web application that connects pet lovers with adoptable pets in their area. This project aims to simplify the process of pet adoption by providing a user-friendly platform.

Table of Contents

• PetHaven
  • Table of Contents
  • Installation
    • Backend Virtual Environment
  • Usage
  • Contributing
  • License

Installation

1. Clone the repository: git clone https://github.com/SimbaDevs/PetHaven.git
2. Navigate to the project directory: cd PetHaven
3. Install dependencies: npm install

Backend Virtual Environment

To set up a virtual environment for the backend, follow these steps:

1. Navigate to the backend folder: cd backend
2. Create a new virtual environment: python3 -m venv venv
3. Activate the virtual environment:
   • For Windows: venv\Scripts\activate
   • For macOS/Linux: source venv/bin/activate
4. Install backend dependencies: pip install -r requirements.txt

Usage

1. Start the backend server:
   • Navigate to the backend folder: cd backend
   • Start the server: flask run
2. Start the frontend server:
   • Navigate to the frontend folder: cd frontend
   • Start the server: npm start
3. Open your web browser and go to http://localhost:3000

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature
3. Make your changes and commit them: git commit -m 'Add your feature'
4. Push to the branch: git push origin feature/your-feature
5. Submit a pull request

License

This project is licensed under the MIT License.