Skip to content

CodingItWrong/surely-api

Repository files navigation

Surely

Official backend for the Surely todo app. A JSON:API-compliant web service implmented in Ruby on Rails.

The official frontend is surely-expo. If you'd like to host your own backend, you will need to make your own build of the client to point to it.

Requirements

  1. Ruby 3.0.2
  2. PostgreSQL (e.g. Postgres.app)

Installation

$ bundle install
$ rails db:setup

Running

$ bin/serve

Development

To generate models, resources, and controllers:

$ rails generate model widget [fields]
$ rails generate jsonapi:resource widget
$ rails generate jsonapi:controller widget

Testing

$ bin/rspec

Release

Heroku is a good backend hosting option.

License

MIT

About

Official backend for the Surely todo app. A JSON:API-compliant web service implmented in Ruby on Rails.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages