Animagus is a web application utilizing a Rails API backend to serialize app data for the frontend and persist game information to the database.
Please note, this application requires both the front and backend. Click here for instructions on installing and setting up the frontend. Please follow all backend instructions before proceeding with frontend installation.
Please check your Ruby version by typing ruby -v in your terminal prior to installing the application:
- Ruby 2.3.3
- Rails 5.2.2
Click here for more information on installing Ruby and here for more information on installing Rails.
Animagus uses Ruby gems for data serialization. Please use Bundler to manage this application's gems.
To start, please clone or download the repository to your computer. If you are already in your computer's terminal, cd into the directory. If you are in your computers Finder or Explorer, right-click and select an option to open the directory in your terminal.
Make sure you are in the animagus-backend directory before proceeding to the next step.
Type bundle install to install all Ruby gems and dependencies.
Head over to PostgresSQL to download the database this application uses.
Next, run the following commands in the terminal to set up the database:
rails db:create
rails db:migrate
rails db:seedRun rails s to start the server. You should be hosting the development server on localhost:3000.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.