An open API service indexing awesome lists of open source software.

https://github.com/beyarz/menu-backend

Backend repo for a frontend app using Rails api only mode
https://github.com/beyarz/menu-backend

docker docker-compose opensearch opensearch-dashboards redis ruby-on-rails searchkick

Last synced: 3 months ago
JSON representation

Backend repo for a frontend app using Rails api only mode

Awesome Lists containing this project

README

          

# Backend

Backend repo for the [Menu app](https://github.com/Beyarz/Menu-frontend), using rails api mode.
The data loaded into the db is not real and only used for prototyping.
The indexing is done through Searchkick & Opensearch (fork of Elasticsearch).

## Requirements

- Ruby 3.1.2
- Rails 7
- Docker

## Getting started

`chmod +x bin/docker-entrypoint.sh`

### Local rails development

```
bundle
rails db:migrate
rails db:seed
rails server
```

### Remote container development (recommended for Windows)

`docker compose -f docker-compose.dev.yml up`

### Development notes

See [dev.md](dev.md)

## Troubleshoot

`exception": "#"`

Run: `rake searchkick:reindex CLASS=Menu` inside the container or in your terminal

## Improvement

- Add compose service for production
- Write proper tests