/v44-tier3-team-34

Add-project-description-here | Voyage-44 | https://chingu.io/ | Twitter: https://twitter.com/ChinguCollabs

Primary LanguageJavaScript


Pet Pals- Chingu Voyage

πŸš€ Live Demo

  • PetPals Live Currently the server is hosted on Render may need to spin up when starting a session. Please be patient and allow up to 30 seconds when first loggin in.

(back to top)

πŸ“— Table of Contents

πŸ“– [PET PALS]

Welcome to PetPals, the ultimate social media platform for pet lovers! Connect, share, and celebrate the joy of your furry friends. Join us today to embark on a pet-inspired journey with PetPals!

[Pet pals] is a social media app for pet owners that brings joy and helps them connect with each other. Our app will provide a platform for users to share photos and stories about their pets, find and join pet-related events in their local community, and connect with other pet owners for playdates and pet-sitting arrangements.

Users:

  1. As a busy pet owner, I want to be able to easily find and connect with other pet owners in my area without having to spend a lot of time searching through different websites or social media platforms.
  2. As a new dog owner who just moved to a new city, I am feeling lonely and disconnected without my usual social support network. I have been looking for ways to meet other dog owners in her area but haven’t had much luck. I’m excited to try out a social media app for pet owners where I can connect with other dog owners in my neighborhood and set up play dates for my pup.
  3. I have a unique pet with special needs and I want to be able to connect with other pet owners who have similar experiences and can offer advice and support.

A user is able to: -Create an account and user profile and login. -Create posts and categorize them. -View the feed to browse other users' posts. -Interact with other users by liking and commenting on their posts.

πŸ›  Built With

Tech Stack

Client

  • React
  • Vite
  • Node
  • Redux
  • Redux toolkit query
  • Tailwind
  • font awesome
  • HTML
  • CSS

Server

  • NodeJS
  • Express
  • bcrypt
  • jsonwebtoken
  • Mongo DB

Key Features

  • API network calls
  • User authentication
  • Create account, login, change password
  • ES6 and Modularization
  • Post a story about pets and select from categories
  • Add Like reactions on posts
  • Comment on posts

(back to top)

πŸ”­ Future Features

  • Share or repost
  • Add friends
  • Search posts by category or friends
  • Add photos or video to profile and posts
  • Create chat groups
  • Search for other pet users with same interests

(back to top)

πŸ’» Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

  • Node Js
  • Code editor
  • Updated browser

Node required

 install node

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:chingu-voyages/v44-tier3-team-34.git
  cd v44-tier3-team-34

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Linters

To fix Eslint linter erros run:

npx eslint "**/*.{js,jsx}" --fix

Run tests

To run tests, run the following command:

npm run test

Build

You can build this project using:

npm run build

Deployment

You can deploy this project using:

  • Netlify
  • Heroku

(back to top)

πŸ‘₯ Authors

πŸ‘¨β€πŸ’» Catherine Matson ✍️

πŸ‘¨β€πŸ’» Ntihinduka Alpha ✍️

πŸ‘¨β€πŸ’» James Ian ✍️

πŸ‘¨β€πŸ’» Greg Schoenberg ✍️

(back to top)

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, show your support by giving a star ⭐️ to this project

(back to top)

πŸ™ Acknowledgments

We would like to thank all the contributors and chingu.

(back to top)

❓ FAQ

  • How can i contribute to this project?

    • Just clone the project and create a pull request with a well detailed feature intended to be added
  • Can I add external libraries?

    • Yes, but it must be license you own the right to or open source library

(back to top)

(back to top)