Merge branch 'staging' into fix-editing-remixes-2

README.md

@@ -1,24 +1,40 @@
-# 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:
+**Please note that these instructions are a work-in-progress!**
 
-* Ruby version
+### Installing Ruby
 
-* System dependencies
+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. Before proceeding, install the GPG keys from the official RVM website.
 
-* Configuration
+```
+\curl -sSL https://get.rvm.io | bash -s stable
+rvm install ruby-3.0.0
+rvm use 3.0.0@granblue --create
+```
 
-* Database creation
+### Installing dependencies
 
-* Database initialization
+After cloning the repo, install the project dependencies with:
 
-* How to run the test suite
+```
+bundle install
+```
 
-* Services (job queues, cache servers, search engines, etc.)
+### Creating the database
 
-* Deployment instructions
+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
+```