Skip to content

xanyah/api

Repository files navigation

Xanyah API

Installation

  • Clone this repo
  • Copy .env.example into .env (or .env.test depending on your environments)
  • Install gems: bundle install
  • Install packages: yarn or npm install
  • Set up your database:
    • Create it with Docker-Compose by running docker-compose up
    • Run the migrations: rake db:migrate
  • You're all set ! 🎉

Generating docs

  • yarn docs

Our stack

  • Ruby on Rails

Contributing

👍🎉 Pull requests are welcome ! 🎉👍