Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hopsoft/stimulus_reflex_todomvc

An implementation of TodoMVC using Ruby on Rails, StimulusJS, and StimulusReflex
https://github.com/hopsoft/stimulus_reflex_todomvc

actioncable reactive ruby-on-rails server-side-rendering stimulus stimulusjs todomvc todomvc-demo

Last synced: about 1 month ago
JSON representation

An implementation of TodoMVC using Ruby on Rails, StimulusJS, and StimulusReflex

Awesome Lists containing this project

README

        

[![Lines of Code - app directory](http://img.shields.io/badge/lines_of_code-202-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
[![Maintainability](https://api.codeclimate.com/v1/badges/e00a9353bc3d2a7edfbd/maintainability)](https://codeclimate.com/github/hopsoft/stimulus_reflex_todomvc/maintainability)
[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)

# StimulusReflex TodoMVC

An implementation of [TodoMVC](http://todomvc.com) using [Ruby on Rails](https://rubyonrails.org),
[StimulusJS](https://stimulusjs.org), and [StimulusReflex](https://github.com/hopsoft/stimulus_reflex).

Expands on the original goals of [TodoMVC](http://todomvc.com) by providing a full application...
including a server and database.

## Demo

https://stimulus-reflex-todomvc.herokuapp.com

_You may notice some latency related to hosting on **free tier** services._

## Local Setup

1. Install dependencies

- [Ruby](https://www.ruby-lang.org/en/downloads/)
- [Yarn](https://yarnpkg.com/lang/en/docs/install/#mac-stable)
- [PostgreSQL](https://www.postgresql.org/download/)

1. Clone the repo

```sh
git clone https://github.com/hopsoft/stimulus_reflex_todomvc.git
```

1. Switch into the project folder

```sh
cd stimulus_reflex_todomvc
```

1. Run the setup command

```sh
bin/setup
```

1. Start the rails server

```sh
bin/rails server
```

1. See the app in action

To see the application in action, open a browser window and navigate to http://localhost:3000. That's it!

## Code

### Important Files

- [HTML Templates](https://github.com/hopsoft/stimulus_reflex_todomvc/tree/master/app/views/todos)
- [Rails Controller](https://github.com/hopsoft/stimulus_reflex_todomvc/blob/master/app/controllers/todos_controller.rb)
- [Stimulus Controller](https://github.com/hopsoft/stimulus_reflex_todomvc/blob/master/app/javascript/controllers/todos_controller.js)
- [Stimulus Reflex](https://github.com/hopsoft/stimulus_reflex_todomvc/blob/master/app/reflexes/todos_reflex.rb)

[View a diff with all changes.](https://github.com/hopsoft/stimulus_reflex_todomvc/compare/9e1c0b3...master)

## Contributing

This project uses [Standard](https://github.com/testdouble/standard)
and [Prettier](https://github.com/prettier/prettier) to minimize bike shedding related to code formatting.
Please run `./bin/standardize` prior submitting pull requests.