Pawpal (BackEnd)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Pawpal]

This repo holds the BackEnd development source for the Pawpal App, the world's best free pet-sitting website. Pawpal allows visitors to connect with pet owners who need help caring for their furry friends. Visitors can stay at the pet owner's home for free in exchange for providing pet sitting and other pet care services.

Visitors can search for pet owners in their area and contact them to discuss the details of the pet care arrangement.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Server

• ROR (BackEnd Repo)

Database

• PostgreSQL
• 

Other

• GitHub flow
• Stylelint

Key Features

• [Add an accommodation]
• [Make a reservation]

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to work on this project, you need to have the following dependencies installed:

• Ruby
• Postgresql
• Node.js
• yarn
• Rails

Setup

Clone this repository to your desired folder:

sh git clone git@github.com:Hannziegel/budget-app.git cd Budget-app

Commands to run

To get all the gems required for the project:

bundle install

To install packages such as style linters:

npm install

To check linters locally, use:

rubocop

npx stylelint "**/*.{css,scss}"

Once you have the project correctly set up, run:

To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes:

bin/rails db:setup

Finally, each time you make changes to the project, run

In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description:

bundle exec rspec /spec

Usage

To run the project, execute the following command:

rails server

--->

Run tests

To run tests, run the following command:

sh bin/rails test test/models/article_test.rb

(back to top)

👥 ✍️ Authors

👩‍💻 Karla Delgado ✍️

• GitHub: @karlavdelgadof
• Twitter: @karlavdelgadof
• LinkedIn: Karla Delgado

👨‍💻 Rodrigo Reckziegel ✍️

• GitHub: @Hannziegel
• LinkedIn: Rodrigo Johann Reckziegel Nunes

👨‍💻 Karam Fouad ✍️

• GitHub: @karam084 Twitter: [@ElarabFouad] LinkedIn: Karam Fouad

(back to top)

🔭 Future Features

• [Allow user to upload avatar]
• [Include "My Profile" section/page]

(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 or find it useful/interesting, please make sure you give ⭐️ a since this will make it easily accesible for you too!

(back to top)

🙏 Acknowledgments

This work is licensed under a Creative Commons Attribution 4.0 International License.

(back to top)

📝 License

This project is MIT licensed.

(back to top)