Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.28 KB

README.md

File metadata and controls

53 lines (32 loc) · 2.28 KB
Raw

Hello from Shorty's Rescue!

We're happy to show you Shorty's Rescue, a place made to help dogs find their new homes. You can look at their pictures and tell us if you want to take care of them. There's also a part where you can give money to help us, help the dogs.

Thank you for your interest in Shorty's Rescue. Let's make a change together!

What We're Doing

  • Why:
    • Shorty's Rescue wants to make it easier for dogs to find new homes by giving people a good way to meet with them.
  • What We Want:
    • Pair people who want a dog with dogs that need a home.
  • Who We're Talking to:
    • People who want to save a dog.
  • Who We Are:
    • Shorty's Rescue was founded by a group of people wanting to better the lives of dogs in need.

Technologies Used

  • React: A JavaScript library used for building user interfaces.
  • Mongoose: An Object Data Modeling (ODM) library for MongoDB and Node.js.
  • Express: A web application framework for Node.js.
  • MongoDB (Cloud Database): A NoSQL database service that uses a document-oriented data model.

Getting Started

To start using Shorty's Rescue on your own computer, follow these steps:

  1. Clone the repository: To "clone" means to make another one of something. In this situation, "cloning" means to make another one of Shorty's Rescue on your own computer.

    git clone https://github.com/okrayum/Shorty-s-Rescue.git

  2. Install dependencies for the client: "Install" sets up or adds something to your computer for use. "Dependencies" are more things that Shorty's Rescue needs to work as usual. In this case, "client" is where the frontend part of Shorty's Rescue is. The frontend of Shorty's Rescue will be the part you see and use with things like forms, and pictures.

    cd client

    npm install

  3. From the client folder start the frontend:

    npm run start

This will only let you see the frontend of Shorty's Rescue at this time. Forms will not work. You will not have use of the "Admin" side.

Possible Problems

There may be some things that don't work as expected. If you run into any other problems, feel free to reach out for help.

Contributions

Help is accepted! If you'd like to help with Shorty's Rescue, please reach out to GitHub user okrayum for directions.

Feel free to suggest changes or mention problems.