Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 4.47 KB

README.md

File metadata and controls

82 lines (65 loc) · 4.47 KB

Pet Adoption Platform

Welcome to my Pet Adoption Platform. This project was created to hone my full-stack development skills, incorporating Node.js, Express.js, React.js, and MongoDB. Below you'll find an overview of the features, technologies used, and how to set up and run the application.

Technologies Used

  • Node.js: Backend runtime environment for running JavaScript code.
  • Express.js: Web application framework for building APIs and handling HTTP requests.
  • React.js: Frontend library for building user interfaces with reusable components.
  • MongoDB: NoSQL database for storing pet and user data in a flexible JSON-like format.

css3 figma git html5 javascript mongodb nodejs react

Features

User Management

  • Registration: Users can sign up for an account by providing basic information.
  • Login/Logout: Registered users can log in securely to access the platform's features and log out when they're done.
  • Authentication: Authentication mechanisms are in place to ensure the security of user data and actions.

Pet Adoption

  • Browse Pets: Users can browse through a list of available pets up for adoption.
  • Search and Filter: Users can search for specific pets or filter them based on criteria such as species, age, or location.
  • Pet Details: Each pet has a detailed profile showcasing information like breed, age, personality, and adoption status.

Dashboard

  • User Dashboard: Registered users have access to a personalized dashboard where they can manage their profile, view their adopted pets, and track their favorite pets.
  • Admin Dashboard: Administrators have special privileges to manage pets available for adoption and handle user accounts.

Getting Started

Follow these instructions to get the Pet Adoption Platform up and running on your local machine.

Prerequisites

  • Node.js and npm installed on your machine
  • MongoDB installed and running locally or access to a MongoDB instance

Installation

  1. Clone the repository to your local machine:
https://github.com/eitanklass1/pet-adoption-platform.git
  1. Navigate to the project directory:
cd pet-adoption-platform
  1. Install dependencies for both backend and frontend:
cd backend && npm install
cd ../frontend && npm install
  1. Set up environment variables:
  • Create a .env file in the backend directory.
PORT = 8080
MongoDB_uri =

TOKEN_SECTRET_KEY = 
CLOUDINARY_CLOUD_NAME = 
CLOUDINARY_API_KEY = 
CLOUDINARY_API_SECRET =

Running the Application

  1. Start the backend server:
cd backend && nodemon server.js
  1. Start the frontend development server: bash Copy code
cd frontend && npm start
  1. Access the application in your web browser at http://localhost:8080.

Gallery

Authors

Contributors names and contact info

ex. Eitan Klass