This is a school management tool. In the long term, it might become a base of knowledge to help develop future applications.
It uses Rails for its backend and a flexible MPA for its frontend. Flexible because you can use any framework you want for any of its SPA's.
The main objective is to create a totally decoupled app in the sense that frontend and backend are totally separated things, but in the same time, keeping as much as possible the Rails way of doing things so we don't diverge too much.
We achive that by having a MPA (multi-page application) structure, where every route is routed by Rails and every page has its own application, whenever needed. It's similar to having multiple SPA applications under the same domain, having the route as its entry-point.
- Ruby (or rbenv)
- NodeJS (or nodenv)
- MySQL
Download this repo and ensure you have the dependencies installed. Now, run:
$ bin/setup
Then it will install everything automatically for you. Once it's done, you can run the project.
Because this app uses a decoupled architecture, you need to run two apps, the backend server and the frontend assets compilation runtime.
$ bin/rails server- Backend server$ bin/gulp watch- Frontend app watcher
It's important that we have a good quality software that it's easy to maintain, collaborate and use. See info.
It's good that most of the time we are learning new stuff. Let's leverage this product and architecture to enable us to step out of our comfort zone.
Let's join this adventure, and live on the edge, not forgetting the first rule.
Given the circumstances, we will the utmost to make it easy for the developer to just code, and stop being worried about the other aspects, such as CI, setup, etc. We'll aim to automatize most of repetitive tasks.
We have a few architecture decisions that we want to be guided by while developing this application.
We want to decouple front-end from back-end so that we can live free of vendor lock-in (or in this case - opinion lock-in). This means that while Rails provides us a great set of good defaults, its opinionated nature (Rails Way) sometimes gets in our way to innovate. This is one case where we want to part ways with Rails Way. We want to have different applications that are tightly tied together, and whenever we want, we can easily replace one or another.
With a detached application, we also want to be flexible enough not to have to be using one framework to build the entire frontend stack. Instead, whenever possible, we could just use jQuery, or even not use Javascript at all. We achieve that by having one JS/CSS entry-point for every routed HTML page.
Let's leverage Rails's I18n features to enable a multi-language software.
- How to create a new feature
- Release and deployment
- Continuous Integration
- Backend architecture
- Frontend architecture
BSD 3-Clause.