https://github.com/codingitwrong/surely-api

Official backend for the Surely todo app. A JSON:API-compliant web service implmented in Ruby on Rails.
https://github.com/codingitwrong/surely-api

json-api rails

Last synced: 2 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/codingitwrong/surely-api
• Owner: CodingItWrong
• License: mit
• Created: 2019-11-22T00:34:29.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-06T20:49:36.000Z (23 days ago)
• Last Synced: 2025-01-06T21:32:34.093Z (23 days ago)
• Topics: json-api, rails
• Language: Ruby
• Homepage: https://surelytodo.com
• Size: 271 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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](https://github.com/CodingItWrong/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

1. PostgreSQL (e.g. [Postgres.app][postgres-app])

## Installation

```sh

$ bundle install

$ rails db:setup

```

## Running

```bash

$ bin/serve

```

## Development

To generate models, resources, and controllers:

```bash

$ rails generate model widget [fields]

$ rails generate jsonapi:resource widget

$ rails generate jsonapi:controller widget

```

## Testing

```sh

$ bin/rspec

```

## Release

[Heroku](https://www.heroku.com/) is a good backend hosting option.

[postgres-app]: http://postgresapp.com

## License

MIT