Cheeky API is a backend built to work in conjunction with the Cheeky frontend to serve data for a gig booking app for Drag Queens! This app was developed to serve queens to help them get connected with the people that need their talents.
If you're reading this and haven't checked out the front end for this web app, read through that documentation here before proceeding with the backend.
Cheeky was created with Ruby 3.1.1p18 on Rails 7.0.4. on a postgreSQL server, and makes use of the jb gem, jwt gem, geocoder gem, and jsonapi-serializer gem, as well as an Active storage migration enabling users to upload files directly to the database.
This app is currently in development, but can be cloned and run on a local server, currently designated to port 3000 upon server start and JSON served by the API can be veiwed in-browser at the default Rails server location http://localhost:3000
Navigate to your desired directory and use the following command to clone down...
git clone https://github.com/kyle-pazdel/cheeky-apichange directories to the new clone...
cd cheeky-apithen bundle install all dependencies with,
bundle installRun the following commands to create a rails database and migrate.
rails db:create
rails db:migrateShould you wish to use the seed data for users, queens, and bookings to get a feel for the app's flow, run the following command.
rails db:seedTo execute a local instance of the Cheeky API, start a rails server with
rails serverFrom there, and with your front end running, you can navigate to http://localhost:5173 to begin interacting with the app's features!
• Custom JSON templates rendered for the following models via their CRUD controllers: User • Performer • Booking • Review • Session • Post
• Image storage using Rails' ActiveStorage, configuring via serialized JSON, and served with a localhost link directly in-browser