STAY A WHILE BACK-END

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Kanban Board
  • 🚀 Live Demo
  • 🚀 Front-End Link
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

🏡STAY A WHILE BACK-END

Stay A While Backend holds the BackEnd development source rails api of an app that allows users to reserve an apartment or home.

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

UML Diagram

• 

🚀 Kanban Board

We are a team of four members Asha , Emmanuella ,Samuel and Rohit

Project link

Initial Kanban Board Status

Key Features

• JWT Authorization upon login and register
• Create Home Stays and Reservations
• Rspec Unit testing

(back to top)

🚀 Live Demo

Stay-A-While

(back to top)

🚀 Front-End Link

Stay-A-While

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

• To install ruby on your PC. You can read this documentation on how to do so
• To install postgresql on your PC. You can read this documentation on how to do so
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VSCode
• In order to run this project you need:

Setup

In desired folder or directory in the CLI, run the command:

git clone git@github.com:asharanjith/stay-a-while-back-end.git

Navigate into the cloned folder or repository by running the command:

cd stay-a-while-back-end

If VsCode is your default code editor, run:

code .

You are all set up!

Install

Install this project with:

 bundle install

Usage

To setup the database, run

rails db:drop db:create db:migrate db:seed

Deployment

To add the master.key and add key value pair for jwt secret key, follow the following

1. Please delete config/credentials.yml.enc & config/master.key and run the bellow lin in command prompt
2. Run below command (run only in vs code)

    EDITOR=code rails credentials:edit

3. Run below command

EDITOR="code --wait" bin/rails credentials:edit

4. In the new file opened after running the above command, add a key value pair there for jwt

To run the project, execute the following command:

ruby bin/rails server

You can deploy this project using:

http://[::1]:3000
or
http://127.0.0.1:3000
or
localhost:3000

Run tests

To run tests, run the following command:

  rspec spec

• The file database.yml is already configured to use those variables

(back to top)

👥 Authors

👤 Asha S Vijayan

• GitHub: @asharanjith
• Twitter: @asha_cep
• LinkedIn: asha-vijayan

👤 Emmanuella Adu

• GitHub: @elarhadu
• Twitter: @elarh_
• LinkedIn: Emmanuella Adu

👤 Samuel Kyere

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Rohit Bhatt

• GitHub: @rbhatt1999
• Twitter: @RohitBhatt
• LinkedIn: Rohit Bhatt

(back to top)

🔭 Future Features

• Payment integration
• Messaging system
• Reviews and ratings
• Social media integration such as Facebook, Twitter, and Instagram to enable users to share their experiences and promote the properties they have stayed in.
• Integration with third-party services such as Google Maps to provide location-based information and directions to properties.

(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 give us a ⭐

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for this project inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)