README.md

Hope Sanctuary

A MERN stack pet adoption website that aims to simplify the process of finding homes for animals that are present in adoption organizations and shelters.

Prototype (Click here to view prototype)

Instructions

1. Clone the Repository & Install Axios

   git clone https://github.com/albinzayedrawan/hopesanctuary.git
   cd hopesanctuary
   npm install

2. Install Dependencies
   Navigate to the frontend and backend folders to install dependencies.

   • Frontend (React):

     cd frontend
     npm install

   • Backend (Node.js/Express):

     cd ../backend
     npm install

3. Set Up Environment Variables
   Create a .env file in the backend directory with the following variables:

   PORT=5000
   DB_URI=your_mongo_db_connection_string
   JWT_SECRET=your_jwt_secret

4. Run the Application
   Open two terminals to run both frontend and backend:

   • Frontend:

     cd frontend
     npm start

   • Backend:

     cd backend
     node index.js

5. Access the Application
   Open your browser and navigate to http://localhost:3000 to view the application.

Features

• User Authentication: Register and login securely with JWT.
• Animal Listings: View all available pets for adoption.
• Search and Filters: Easily find pets based on species, breed, age, and location.
• Responsive Design: Accessible on all devices.
• Admin Dashboard: Manage animal listings and adoption requests.

Technologies Used

• Frontend:
• Backend:
• Database:
• Authentication:
• Version Control:

Project Structure

hopesanctuary/
├── backend/            # Backend API
├── frontend/           # Frontend Application
├── CONTRIBUTING        # Project Contribution Instructions
├── LICENSE             # Project License
├── README.md           # Project Documentation

Contributing

We welcome contributions! See the CONTRIBUTING file for details.

License

This project is licensed under the MIT License. See the LICENSE file for details.