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

https://github.com/tristandunn/bookmarks

A bookmarking application built with Ruby on Rails.
https://github.com/tristandunn/bookmarks

bookmarks rails ruby ruby-llm ruby-on-rails solid-queue

Last synced: 3 months ago
JSON representation

A bookmarking application built with Ruby on Rails.

Awesome Lists containing this project

README

          

# Bookmarks ![CI](https://github.com/tristandunn/bookmarks/workflows/CI/badge.svg)

A bookmarking application built with Ruby on Rails.

## Features

* Background jobs with [SolidQueue][].
* Content summarization with [Readability][].
* Bookmark summary generation with [RubyLLM][].

## Development

Install the dependencies and setup the database.

```
bin/setup
```

To run the application processes.

```
bin/dev
```

If you're making changes, be sure to write and run the tests.

```
bundle exec rake ruby:test
bundle exec rake javascript:test
```

Before pushing changes, check the code.

```
bundle exec rake css:lint
bundle exec rake erb:lint
bundle exec rake ruby:lint
bundle exec rake javascript:lint
```

Or you can run the tests with coverage and lint with a single command.

```
bundle exec rake check
```

### Docker

Build the image with Docker.

```
docker build -t bookmarks .
```

Run the server using the image.

```
docker run --rm -p 3000:80 -e SECRET_KEY_BASE=$(bin/rails secret) --name bookmarks bookmarks
```

## License

Bookmarks uses the MIT license. See [LICENSE](LICENSE) for more details.

[Readability]: https://github.com/cantino/ruby-readability
[RubyLLM]: https://rubyllm.com
[SolidQueue]: https://github.com/rails/solid_queue/