🎰 VR-WORLD API 👣

📗 Table of Contents

• 📗 Table of Contents
• 🪮 VR-WORLD API
• 🛠 Built With
  • 📌 Tech Stack
• 🗝 Key Features
• 📑 Documentation
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Usage
  • Run tests
• 🧑🏽‍💻 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• 📝 License

🪮 VR-WORLD API

Unlocking Virtual Reality Experiences with Ease!

VR-WORLD API is a powerful application built using Rails, designed exclusively for developers and enthusiasts who want to integrate virtual reality experiences into their own applications or platforms.

With VR-WORLD API, you can seamlessly access and leverage our extensive collection of virtual reality content and functionalities.

🛠 Built With

📌 Tech Stack

Domain	Tech Stack
Server	Ruby on Rails
Database	PostgreSQL
Testing Framework	RSpec Rails
Authentification	Devise, JWT
Documentation	RSwag

(back to top)

🗝 Key Features

• GET studios
• GET studio
• POST studio
• DELETE studio
• GET reservations
• POST reservation
• User can sign up
• User can log in
• User can log out

(back to top)

📑 Documentation

You can learn more about our API on this 👉 Live documentation

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

• Ruby 3.2.2 installed

• Rails installed

Run this command to install Rails

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:rica213/vr-world.git

To install dependencies, run:

bundle install

A secret_key_base is required to run the Devise

Run this command in the bash terminal to generate it:

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

Set up the database

A database.yml file is required to use database

Here are the steps to be followed to create one

1- Copy the file database_sample.yml located in the directory vr-world/config
2- Rename your copy of database_sample.yml into database.yml
3- Make necessary configuration following the instructions provided in the file according to your database configuration

To create the database, run:

rails db:create

To create the schema, run:

rails db:migrate

Usage

To run the project, execute the following command:

Example command:

  rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

🧑🏽‍💻 Authors

🫠 Clarielle Larissa 🇲🇬

• GitHub: @rica213
• Twitter: @alc3and
• LinkedIn: Clarielle Larissa

😁 Shaaibu Suleiman 🇳🇬

• GitHub: @shaaibu7
• Twitter: @SuleimanShaaibu
• LinkedIn: Shaaibu Suleiman

😎 Samuel Amankwaa-Frempong 🇬🇭

• GitHub: @frempongdev
• Twitter: @knobaddy
• LinkedIn: Frempong

🤓 Ambrose Kibet 🇰🇪

• GitHub: @ambrose-kibet
• Twitter: @ambrose_kibet
• LinkedIn: Ambrose Kibet

(back to top)

🔭 Future Features

• GET reservation
• UPDATE reservation
• DELETE reservation
• UPDATE studio

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Show Your Support for VR-WORLD API!

As a platform dedicated to bringing you the best VR experiences, we greatly value your support.

Here are a few ways you can show your enthusiasm and help us spread the word about VR-WORLD:

🗣️ Spread the Word: Share your VR-WORLD experience with friends, family, and colleagues.

📲 Engage on Social Media: Follow us on our social media channels and actively engage with our posts.

✍🏻 Provide Feedback: We value your input and want to continuously enhance the VR-WORLD experience.

⭐️⭐️⭐️⭐️ Star the repository: Star is our currency 💸

Thank you for your support and for being a part of this journey! ❤️

(back to top)

🙏 Acknowledgments

We would like to thank:

• Microverse
• Code Reviewers

(back to top)

📝 License

This project is MIT licensed.

(back to top)