From 39567fcefdaad914e747d3909b55853fa4bf2170 Mon Sep 17 00:00:00 2001 From: Justin Edmund Date: Sun, 5 Feb 2023 23:42:00 -0800 Subject: [PATCH] Update README.md --- README.md | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7db80e4..bd86ff9 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,42 @@ -# README +# hensei-api -This README would normally document whatever steps are necessary to get the -application up and running. +**hensei-api** is the backend for [granblue.team](https://app.granblue.team/), an app for saving and sharing teams for [Granblue Fantasy](https://game.granbluefantasy.jp). -Things you may want to cover: +## Getting Started -* Ruby version +**Please note that these instructions are a work-in-progress!** -* System dependencies +### Installing Ruby -* Configuration +You'll need to install ruby-3.0.0. We recommend using [RVM](https://rvm.io/) and creating a gemset to manage your Ruby installation. -* Database creation +``` +\curl -sSL https://get.rvm.io | bash -s stable +rvm install ruby-3.0.0 +rvm use 3.0.0@granblue --create +``` -* Database initialization +### Installing dependencies -* How to run the test suite +After cloning the repo, install the project dependencies with: -* Services (job queues, cache servers, search engines, etc.) +``` +bundle install +``` -* Deployment instructions +### Creating the database -* ... +Once the dependencies have been installed, you'll need to create and seed the database. Seed data is provided but may not be up-to-date! + +``` +rails db:create +rails db:migrate +rails db:seed +``` + +### Running the server + +Then, you can start the server with: +``` +rails server +```