Artbsc1992/back-end-capstone-fullstack

Book game API

The book your dream game API allows all the end points necessary for:

• Create a stadium
• Create a game by selecting the list of teams
• Choose the desired date of the game
• Reserve the seats you want (if available)
• View all the reservations that the user owns

Front End Repo

Built With

• Ruby on Rails
• PostgreSQL
• JWT
• Rswag

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

• Ruby ruby-3.1.2 installed
• PostgreSQL dbms running

Setup

• Open your terminal and navigate to the folder you would like to save the project.

• Type these commands into the terminal:

git clone https://github.com/rega1237/back-end-capstone-fullstack
cd back-end-capstone-fullstack
bundle install
bundle exec figaro install

• The bundle exec figaro install is to install and create the application.yml file and create the environment variables

• You will need to configure your application.yml file before you install and run the project. The application.yml file contains environment variables needed to deploy the webpage. You can find this file in the folder config/application.yml. There is a commented application_example.txt file you can use as a guide to configure your own.

• Edit file application.yml

  • Provide the values for the variables
    • DATABASE_HOST
    • DATABASE_USER
    • DATABASE_PASSWORD

• Type this commands into the terminal:

rails db:create
rails db:reset

Run application

• Type this command into the terminal:

rails server

• Open your web browser at http://127.0.0.1:3000/

Testing

• Type this command into the terminal:

rails db:migrate RAILS_ENV=test
rails db:seed RAILS_ENV=test
rspec

Documentation

• With the server open go to http://localhost:3000/api-docs/index.html

Author

👤 Rafael E. Guzman Arias

• GitHub: @rega1237
• LinkedIn: Rafael E. Guzman Arias

👤 Dangelo Arrivillaga

• GitHub: @Dangelo-JAN
• LinkedIn: Soluciones Empresriales Dangelo Arrivillaga

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse for the motivation.

📝 License

This project is MIT licensed.