- ๐ Table of Contents
- ๐ชฎ VR-WORLD API
- ๐ Built With
- ๐ Key Features
- ๐ Documentation
- ๐ป Getting Started
- ๐ง๐ฝโ๐ป Authors
- ๐ญ Future Features
- ๐ค Contributing
- โญ๏ธ Show your support
- ๐ Acknowledgments
- ๐ License
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.
Domain | Tech Stack |
---|---|
Server | Ruby on Rails |
Database | PostgreSQL |
Testing Framework | RSpec Rails |
Authentification | Devise, JWT |
Documentation | RSwag |
- GET studios
- GET studio
- POST studio
- DELETE studio
- GET reservations
- POST reservation
- User can sign up
- User can log in
- User can log out
You can learn more about our API on this ๐ Live documentation
To get a local copy up and running, follow these steps.
In order to run this project you need:
-
Ruby 3.2.2 installed
-
Rails installed
Run this command to install Rails
gem install rails
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
To run the project, execute the following command:
Example command:
rails server
To run tests, run the following command:
rspec
๐ซ 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
- GET reservation
- UPDATE reservation
- DELETE reservation
- UPDATE studio
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
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:
๐ฒ 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.
Thank you for your support and for being a part of this journey! โค๏ธ
We would like to thank:
- Microverse
- Code Reviewers
This project is MIT licensed.