Skip to content

Peternals/pet-pals-server

Repository files navigation

This was created during our time as a student at Code Chrysalis.

🐶🐢🐱🐰 Pet Pals (Server) 🦜🐷🐭🦦

This is the server side repository. You need to run the client side at the same time. This is Client Repository.

  1. About 💁
  2. Features ✨
  3. Requirements 🙏
  4. Getting Started 🎬
  5. Tech Stack 🤖
  6. Authors 📝

About 💁

This is an application that connects the people who want to interact with animals with pet owners.
If you want to have an animal, but can't for some reasons, this app can allow you to connect a pet owner who has the pet which you want to interact with and meet it in parson.
If you already have pets, but can't look after them well for some reasons, this app can allow you to connect people who love animals and ask them to look after them safely.

Features ✨

1. Questionnaire

Pet owners can request carers (people who search pets) to answer some questions to comfirm if the carer is a safe person. Only when an owner checks an answer of questionnaire and accepts the offer from a carer, the carer can meet the pets in person.

2. Tag Search

Carers can easily search pets which they are interested in with tag system. They can register the tags as their interests in advance, and change the tags in search page anytime.

3. Chat Functionality

When an owner accept offers from a carer, they can use chat functionality to talk more concretely with each other. This functionality removes the anxiety of both owners and carers by communicating with each other directly.

4. Notification

When a carer sends a request to meet a pet, it will be notified to the owner in real time. Also, when an owner approves a carer's request, it will be notified in real time to the carer. With this feature, both will not overlook the action from the other.

Requirements 🙏

To use this application,

  • This is the server side repository. You need to run the client side at the same time. This is Client Repository.
  • You need Node.js, npm installed on your computer. Also, you need to use mongodb on your computer or on cloud.

Getting Started 🎬

1. Install Dependencies

To install all dependencies, run this code in your terminal.

npm install

2. Set Up Environment Variables

To set up environment variables, create .env file and set up your own environment variables in the file.

ACCESS_TOKEN_SECRET= //anything is okay
MONGO_URL= //your mongodb URL

3. Run the server

To start the server, run this code in your terminal.

npm run dev

4. Access To Your Local Host

To see the app, run the client server (more detail).
After running the client server, open your browser and access your local host url which you set up in .env file in client side.

5. Let's get started!

Screen Shot 2021-11-24 at 19 17 11

Tech Stack 🤖

mongodb image JWT image Socket.io image
mongoDB JWT Socket.io

Authors 📝

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •