BlogMVC

Rails 5 Blog MVC project

Try it

• Clone project (git clone git@github.com:anthony-robin/BlogMVC.git)
• Go to project folder (cd BlogMVC)
• Run setup script (bin/setup)

Run project

It is recommended to use Foreman to run the differents processes:

$ gem install foreman
$ foreman start

This will execute the rails server, the webpack assets compiler and watcher and maildev (npm plugin to intercept emails in local)

Documentation

Documentation is handled by yard. To have a look at the documentation run yard server in a terminal and visit http://localhost:8808.

Testing and linters

This project comes with a set of rspec tests. To run them:

$ bin/rspec

To execute rubocop linter:

$ bin/rubocop

The javaScript linter (through yarn script):

$ bin/yarn run eslint

The sass linter (through yarn script as well):

$ bin/yarn run sasslint

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Ensure specs and linters turn greens
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create new Pull Request