README

work view code

this is an opinionated home work to build a word book web applications with Ruby on Rails and flowbite ui. It simplifies the process of setting up a new application while following best practices.

Backend

• Ruby 3.2.2
• Ruby on Rails 7.0.6
• PostgreSQL for use as SQL database
• Sidekiq for background processing
• Redis for Caching, ActionCable, and Sidekiq
• Puma is a simple, fast, multi-threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications.

Frontend

• hotwire Hotwire is an alternative approach to building modern web applications without using much JavaScript by sending HTML instead of JSON over the wire
• Tailwind CSS 3 to not have to write CSS at all
• https://flowbite.com/ Build websites even faster with components on top of Tailwind CSS.
• esbuild An extremely fast bundler for the web

Development

• Foreman for starting up the application locally
• Overmind for Process manager for Procfile-based applications and tmux
• dotenv to load environment variables from .env into ENV
• Prettier for auto-formatting JavaScript and Ruby code in Visual Studio Code
• Live reloading

Linting and testing

• RuboCop for Ruby static code analysis
• ESLint for JavaScript static code analysis
• RSpec for Ruby testing

Getting started

Install for development

1. Clone the repo locally:

git clone https://github.com/jisuanjixue/work_view
cd work_view

1. Install PostgreSQL, Redis, ruby, gem, javascript node module etc Setup the application to install gems and NPM packages and create the database::

bin/setup

5. Start the application locally:

overmind start

Then open http://localhost:3000 in your browser. use devise for login, username: aa11, password: 123456

Running linters

RuboCop:

bin/rubocop

ESLint:

bin/yarn lint

Running tests locally

Ruby tests:

bin/rspec
open coverage/index.html

JavaScript unit tests:

bin/yarn test