Pawsitive

📗 Table of Contents

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

Pawsitive

Pawsitive is an app designed to connect pet owners and caregivers who live within a 5-10 mile radius. The app offers two types of services: daycare, which is provided hourly from 7 AM to 8 PM, and boarding, which can last up to one week.

🛠 Built With

Tech Stack

Ruby

• Ruby

Rails

• Rails

PostgreSQL

• PostgreSQL

Key Features

• Create Skeleton App: Initial setup of the application structure.
• Add Authorization Rules: Implementing access control mechanisms.
• Add API Endpoints: Creating endpoints for API interaction.
• API Documentation: Documenting API endpoints and usage.
• Creating a Data Model: Designing the database schema.
• Validations and Model Specs: Implementing validations and writing tests for models.
• Processing Data in Models: Handling data logic within models.
• Setup and Controllers: Setting up controllers and routes.
• Controllers Specs: Writing tests for controllers.
• Views: Developing user interface components.
• Forms: Creating forms for user input.
• Add Devise: Implementing user authentication.
• Add AWS S3 Config: Configuring AWS S3 for file storage.
• Add Location Map: Integrating a map to display locations.

(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:

gem install ruby
gem install rails
gem install foreman

Setup

Clone this repository to your desired folder:

cd folder
git clone git@github.com:chingu-voyages/v49-tier3-team-31.git

Install

Install this project with:

cd my-project
bundle install

Configuration

Configure the database.yml file with your database credentials:

development:
  <<: *default
  database: pawsitive
  username: your_username
  password: your_password
  port: 5432

test:
  <<: *default
  database: pawsitive
  username: your_username
  password: your_password
  port: 5432

Database Setup

Set up the database:

rails db:create
rails db:migrate

Usage

Start the server in your favorite terminal:

rails server
# or
bin/dev

Run Tests

To run tests, execute:

rspec

Deployment

Instructions for deploying the app will be provided in future updates.

(back to top)

👥 Authors

👤 Lincoln

• GitHub: lincoln1883
• LinkedIn: Lincoln Gibson

👤 Gladdy

• GitHub: Gladdy17
• LinkedIn: Gladdy

👤 Jonatan

• GitHub: jcidp
• LinkedIn: Jonatan

(back to top)

🔭 Future Features

• User profile customization.
• In-app messaging between pet owners and caregivers.
• Real-time booking updates.
• Advanced search filters.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show Your Support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgements

• Special thanks to the Chingu team for their support and resources.

(back to top)

📝 License

This project is MIT licensed.

(back to top)