Project architecture - PaulBreugnot/TheMaterialParser GitHub Wiki

This section contains information about which languages, frameworks and technologies are used in this project to better understand its structure.

Rails

TheMaterialParser is based on the Ruby On Rails 5 framework. From there comes the global structure of the project.

If you don't know Rails, you should check the official rails getting started.

Sqlite3

The database used is an sqlite3 database, as used by default by Rails on a development environment.

The database schema can be checked in schema.rb (this file is generated by Rails).

Also remember that once created, you can simply have a direct access to the database using the sqlite3 command line shell, for example with

sqlite3 db/development.sqlite3

from the project root directory.

CoffeScript

Javascript files are actually written in CoffeeScript. This is no big deal, especially considering the fact that the code sent and processed by the browser is still javascript, generated from the CoffeeScript code.

Vue.js

Dynamic data management from the client side is handled with the Vue.js framework, along with the fetch API