mirror of
https://github.com/LaCasemate/fab-manager.git
synced 2024-11-29 10:24:20 +01:00
try to keep indentation
This commit is contained in:
Sylvain
parent
c07aa1dcea
commit
c78b052419
@ -3,63 +3,63 @@
|
|||||||
## Root
|
## Root
|
||||||
|
|
||||||
`fab-manager/`<br>
|
`fab-manager/`<br>
|
||||||
╠═ `.docker/` In development, data of the databases are stored in this untracked folder;<br>
|
`╠═ .docker/` In development, data of the databases are stored in this untracked folder;<br>
|
||||||
╠═ `.github/` Configuration of the GitHub repository;<br>
|
`╠═ .github/` Configuration of the GitHub repository;<br>
|
||||||
╠═ `accounting/` When some accounting exports are generated in the application, they are saved in this untracked folder;<br>
|
`╠═ accounting/` When some accounting exports are generated in the application, they are saved in this untracked folder;<br>
|
||||||
╠═ `app/` **The source code of the application**;<br>
|
`╠═ app/` **The source code of the application**;<br>
|
||||||
╠═ `bin/` Ruby-on-rails binaries;<br>
|
`╠═ bin/` Ruby-on-rails binaries;<br>
|
||||||
╠═ `config/` Application and frameworks configurations are saved here. **Translations are saved here too**; <br>
|
`╠═ config/` Application and frameworks configurations are saved here. **Translations are saved here too**; <br>
|
||||||
╠═ `coverage/` Coveralls.io saves its temporary data into this untracked folder;<br>
|
`╠═ coverage/` Coveralls.io saves its temporary data into this untracked folder;<br>
|
||||||
╠═ `db/` Database schema and migrations (ie. the history of the construction of the database);<br>
|
`╠═ db/` Database schema and migrations (ie. the history of the construction of the database);<br>
|
||||||
╠═ `doc/` Various documentations about Fab-manager;<br>
|
`╠═ doc/` Various documentations about Fab-manager;<br>
|
||||||
╠═ `docker/` Files used to build the docker image. Also: files to set up a development environment based on docker; <br>
|
`╠═ docker/` Files used to build the docker image. Also: files to set up a development environment based on docker; <br>
|
||||||
╠═ `exports/` When some exports are generated in the application, they are saved in this untracked folder;<br>
|
`╠═ exports/` When some exports are generated in the application, they are saved in this untracked folder;<br>
|
||||||
╠═ `imports/` When some files are imported to the application, they are saved in this untracked folder;<br>
|
`╠═ imports/` When some files are imported to the application, they are saved in this untracked folder;<br>
|
||||||
╠═ `invoices/` When some invoices are generated in the application, they are saved in this untracked folder;<br>
|
`╠═ invoices/` When some invoices are generated in the application, they are saved in this untracked folder;<br>
|
||||||
╠═ `lib/` **Some more code of the application**. This code may not be loaded automatically;<br>
|
`╠═ lib/` **Some more code of the application**. This code may not be loaded automatically;<br>
|
||||||
╠═ `log/` When running, the application will produce some debug outputs, they are saved in this untracked folder;<br>
|
`╠═ log/` When running, the application will produce some debug outputs, they are saved in this untracked folder;<br>
|
||||||
╠═ `node_modules` Third party libraries for the front-end JS application are stored in this untracked folder by the package manager (yarn);<br>
|
`╠═ node_modules` Third party libraries for the front-end JS application are stored in this untracked folder by the package manager (yarn);<br>
|
||||||
╠═ `payment_schedules` When some payment schedules are generated in the application, they are saved in this untracked folder;<br>
|
`╠═ payment_schedules` When some payment schedules are generated in the application, they are saved in this untracked folder;<br>
|
||||||
╠═ `plugins/` Some code can be dropped in that untracked folder to use plugins with Fab-manager;<br>
|
`╠═ plugins/` Some code can be dropped in that untracked folder to use plugins with Fab-manager;<br>
|
||||||
╠═ `provision/` Scripts used to setup a development environment based on vagrant;<br>
|
`╠═ provision/` Scripts used to setup a development environment based on vagrant;<br>
|
||||||
╠═ `public` Files that will be exposed to the world by the HTTP server (nginx). This includes the compilation result of the front-end application; <br>
|
`╠═ public` Files that will be exposed to the world by the HTTP server (nginx). This includes the compilation result of the front-end application; <br>
|
||||||
╠═ `scripts/` Some bash scripts. Scripts ran during the upgrade phrase are located here;<br>
|
`╠═ scripts/` Some bash scripts. Scripts ran during the upgrade phrase are located here;<br>
|
||||||
╠═ `setup/` Everything needed to set up a new instance of Fab-manager, including the setup script;<br>
|
`╠═ setup/` Everything needed to set up a new instance of Fab-manager, including the setup script;<br>
|
||||||
╠═ `test/` Automated tests of the application (MiniTest);<br>
|
`╠═ test/` Automated tests of the application (MiniTest);<br>
|
||||||
╠═ `tmp/` Various temporary files are stored in this untracked folder;<br>
|
`╠═ tmp/` Various temporary files are stored in this untracked folder;<br>
|
||||||
╠═ `vendor/` (deprecated) Previously 3rd-party assets were stored here. Now, only the fonts for the PDF generation remains here;<br>
|
`╠═ vendor/` (deprecated) Previously 3rd-party assets were stored here. Now, only the fonts for the PDF generation remains here;<br>
|
||||||
╠═ `.browserslistrc` Required by babel (JS compiler) to specify target browsers for the compilation of the front-end application;<br>
|
`╠═ .browserslistrc` Required by babel (JS compiler) to specify target browsers for the compilation of the front-end application;<br>
|
||||||
╠═ `.coveralls.yml` Configuration of coveralls.io;<br>
|
`╠═ .coveralls.yml` Configuration of coveralls.io;<br>
|
||||||
╠═ `.dockerignore` List of files that won't be included in the docker image;<br>
|
`╠═ .dockerignore` List of files that won't be included in the docker image;<br>
|
||||||
╠═ `.env` Environment variables for development and test environments;<br>
|
`╠═ .env` Environment variables for development and test environments;<br>
|
||||||
╠═ `.eslitignore` List of files that won't be parsed by ESLint;<br>
|
`╠═ .eslitignore` List of files that won't be parsed by ESLint;<br>
|
||||||
╠═ `.eslintrc` Configuration of the JS code quality checking (ESLint);<br>
|
`╠═ .eslintrc` Configuration of the JS code quality checking (ESLint);<br>
|
||||||
╠═ `.gemrc` Ruby gems configuration;<br>
|
`╠═ .gemrc` Ruby gems configuration;<br>
|
||||||
╠═ `.gitignore` List of files that won't be tracked by the version control system (git);<br>
|
`╠═ .gitignore` List of files that won't be tracked by the version control system (git);<br>
|
||||||
╠═ `.nvmrc` Version of node.js used in this project. This file is read by NVM in development environments;<br>
|
`╠═ .nvmrc` Version of node.js used in this project. This file is read by NVM in development environments;<br>
|
||||||
╠═ `.rubocop.yml` Configuration of the Ruby code quality checking (Rubocop);<br>
|
`╠═ .rubocop.yml` Configuration of the Ruby code quality checking (Rubocop);<br>
|
||||||
╠═ `.ruby-gemset` Used by RVM to isolate the gems of this application;<br>
|
`╠═ .ruby-gemset` Used by RVM to isolate the gems of this application;<br>
|
||||||
╠═ `.ruby-version` Version of Ruby used in this project. This file is read by RVM in development environments;<br>
|
`╠═ .ruby-version` Version of Ruby used in this project. This file is read by RVM in development environments;<br>
|
||||||
╠═ `babel.config.js` Configuration of babel (JS compiler);<br>
|
`╠═ babel.config.js` Configuration of babel (JS compiler);<br>
|
||||||
╠═ `Capfile` (deprecated) Configuration of capistrano (previous deployment system);<br>
|
`╠═ Capfile` (deprecated) Configuration of capistrano (previous deployment system);<br>
|
||||||
╠═ `CHANGELOG.md` List of changes between releases of Fab-manager. Also contains deployment instructions for upgrading; <br>
|
`╠═ CHANGELOG.md` List of changes between releases of Fab-manager. Also contains deployment instructions for upgrading; <br>
|
||||||
╠═ `config.ru` This file is used by Rack-based servers to start the application;<br>
|
`╠═ config.ru` This file is used by Rack-based servers to start the application;<br>
|
||||||
╠═ `CONTRIBUTING.md` Contribution guidelines;<br>
|
`╠═ CONTRIBUTING.md` Contribution guidelines;<br>
|
||||||
╠═ `crowdin.yml` Configuration of the translation management system (Crowdin);<br>
|
`╠═ crowdin.yml` Configuration of the translation management system (Crowdin);<br>
|
||||||
╠═ `Dockerfile` This file list instructions to build the docker image of the application;<br>
|
`╠═ Dockerfile` This file list instructions to build the docker image of the application;<br>
|
||||||
╠═ `env.example` Example of configuration for the environment variables, for development and test environments;<br>
|
`╠═ env.example` Example of configuration for the environment variables, for development and test environments;<br>
|
||||||
╠═ `Gemfile` List of third-party libraries used in the Ruby-on-Rails application;<br>
|
`╠═ Gemfile` List of third-party libraries used in the Ruby-on-Rails application;<br>
|
||||||
╠═ `Gemfile.lock` Version lock of the ruby-on-rails dependencies;<br>
|
`╠═ Gemfile.lock` Version lock of the ruby-on-rails dependencies;<br>
|
||||||
╠═ `LICENSE.md` Publication licence of Fab-manager;<br>
|
`╠═ LICENSE.md` Publication licence of Fab-manager;<br>
|
||||||
╠═ `package.json` List of third-party libraries used in the Javascript application. Also: version number of Fab-manager;<br>
|
`╠═ package.json` List of third-party libraries used in the Javascript application. Also: version number of Fab-manager;<br>
|
||||||
╠═ `postcss.config.js` Configuration of PostCSS (CSS compiler);<br>
|
`╠═ postcss.config.js` Configuration of PostCSS (CSS compiler);<br>
|
||||||
╠═ `Procfile` List the process ran by foreman when starting the application in development;<br>
|
`╠═ Procfile` List the process ran by foreman when starting the application in development;<br>
|
||||||
╠═ `Rakefile` Configuration of Rake (Ruby commands interpreter);<br>
|
`╠═ Rakefile` Configuration of Rake (Ruby commands interpreter);<br>
|
||||||
╠═ `README.md` Entrypoint for the documentation;<br>
|
`╠═ README.md` Entrypoint for the documentation;<br>
|
||||||
╠═ `tsconfig.json` Configuration of TypeScript;<br>
|
`╠═ tsconfig.json` Configuration of TypeScript;<br>
|
||||||
╠═ `Vagrantfile` Configuration of Vagrant, for development environments;<br>
|
`╠═ Vagrantfile` Configuration of Vagrant, for development environments;<br>
|
||||||
╠═ `yarn.lock` Version lock of the javascript dependencies;<br>
|
`╠═ yarn.lock` Version lock of the javascript dependencies;<br>
|
||||||
╚═ `yarn-error.log` This untracked file keeps logs of the package manager (yarn), if any error occurs;
|
`╚═ yarn-error.log` This untracked file keeps logs of the package manager (yarn), if any error occurs;
|
||||||
|
|
||||||
## Backend application
|
## Backend application
|
||||||
|
|
||||||
@ -68,23 +68,23 @@ It mainly provides a REST-JSON API for the frontend application.
|
|||||||
It also provides another REST-JSON API, open to the 3rd-party applications, and known as OpenAPI.
|
It also provides another REST-JSON API, open to the 3rd-party applications, and known as OpenAPI.
|
||||||
|
|
||||||
`fab-manager/`<br>
|
`fab-manager/`<br>
|
||||||
╚═╦ `app/`<br>
|
`╚═╦ app/`<br>
|
||||||
╠═ `controllers/` Controllers (MVC);<br>
|
` ╠═ controllers/` Controllers (MVC);<br>
|
||||||
╠═ `doc/` Documentation for the OpenAPI;<br>
|
` ╠═ doc/` Documentation for the OpenAPI;<br>
|
||||||
╠═ `exceptions/` Custom errors;<br>
|
` ╠═ exceptions/` Custom errors;<br>
|
||||||
╠═ `frontend/` **Source code for the frontend application**; <br>
|
` ╠═ frontend/` **Source code for the frontend application**; <br>
|
||||||
╠═ `helpers/` System-wide libraries and utilities. Prefer using `services/` when it's possible;<br>
|
` ╠═ helpers/` System-wide libraries and utilities. Prefer using `services/` when it's possible;<br>
|
||||||
╠═ `mailers/` Sending emails;<br>
|
` ╠═ mailers/` Sending emails;<br>
|
||||||
╠═ `models/` Models (MVC);<br>
|
` ╠═ models/` Models (MVC);<br>
|
||||||
╠═ `pdfs/` PDF documents generation;<br>
|
` ╠═ pdfs/` PDF documents generation;<br>
|
||||||
╠═ `policies/` Access policies for the API and OpenAPI endpoints;<br>
|
` ╠═ policies/` Access policies for the API and OpenAPI endpoints;<br>
|
||||||
╠═ `services/` Utilities arranged by data models; <br>
|
` ╠═ services/` Utilities arranged by data models; <br>
|
||||||
╠═ `sweepers/` Build cached version of some data;<br>
|
` ╠═ sweepers/` Build cached version of some data;<br>
|
||||||
╠═ `themes/` SASS files that overrides the frontend styles. We plan to move all styles here to build multiple themes; <br>
|
` ╠═ themes/` SASS files that overrides the frontend styles. We plan to move all styles here to build multiple themes; <br>
|
||||||
╠═ `uploaders/` Handling of the uploaded files<br>
|
` ╠═ uploaders/` Handling of the uploaded files<br>
|
||||||
╠═ `validators/` Custom data validation (before saving);<br>
|
` ╠═ validators/` Custom data validation (before saving);<br>
|
||||||
╠═ `views/` Views (MVC)<br>
|
` ╠═ views/` Views (MVC)<br>
|
||||||
╚═ `workers/` Asynchronous tasks run by Sidekiq
|
` ╚═ workers/` Asynchronous tasks run by Sidekiq
|
||||||
|
|
||||||
## Frontend application
|
## Frontend application
|
||||||
|
|
||||||
@ -93,23 +93,23 @@ We are moving, step-by-step, to an application based on React.js + Typescript.
|
|||||||
For now, the main application is still using Angular.js but it uses some React.js components thanks to coatue-oss/react2angular.
|
For now, the main application is still using Angular.js but it uses some React.js components thanks to coatue-oss/react2angular.
|
||||||
|
|
||||||
`fab-manager/`<br>
|
`fab-manager/`<br>
|
||||||
╚═╦ `app/`<br>
|
`╚═╦ app/`<br>
|
||||||
╚═╦ `frontend/`<br>
|
` ╚═╦ frontend/`<br>
|
||||||
╠═ `images/` Static images used all over the frontend app;<br>
|
` ╠═ images/` Static images used all over the frontend app;<br>
|
||||||
╠═ `packs/` Entry points for webpack (bundler);<br>
|
` ╠═ packs/` Entry points for webpack (bundler);<br>
|
||||||
╠═╦ `src/`<br>
|
` ╠═╦ src/`<br>
|
||||||
║ ╠═╦ `javascript/`<br>
|
` ║ ╠═╦ javascript/`<br>
|
||||||
║ ║ ╠═ `api/` (TS) New components to access the backend API; <br>
|
` ║ ║ ╠═ api/` (TS) New components to access the backend API; <br>
|
||||||
║ ║ ╠═ `components/` (TS) New React.js components;<br>
|
` ║ ║ ╠═ components/` (TS) New React.js components;<br>
|
||||||
║ ║ ╠═ `controllers/` (JS) Old Angular.js controllers for the views located in `app/frontend/templates`;<br>
|
` ║ ║ ╠═ controllers/` (JS) Old Angular.js controllers for the views located in `app/frontend/templates`;<br>
|
||||||
║ ║ ╠═ `directives/` (JS) Old Angular.js directives (interface components);<br>
|
` ║ ║ ╠═ directives/` (JS) Old Angular.js directives (interface components);<br>
|
||||||
║ ║ ╠═ `filters/` (JS) Old Angular.js filters (processors transforming data);<br>
|
` ║ ║ ╠═ filters/` (JS) Old Angular.js filters (processors transforming data);<br>
|
||||||
║ ║ ╠═ `lib/` (TS) New utilities + (JS) Old external libraries customized; <br>
|
` ║ ║ ╠═ lib/` (TS) New utilities + (JS) Old external libraries customized; <br>
|
||||||
║ ║ ╠═ `models/` (TS) Typed interfaces reflecting the API data models;<br>
|
` ║ ║ ╠═ models/` (TS) Typed interfaces reflecting the API data models;<br>
|
||||||
║ ║ ╠═ `services/` (JS) Old Angular.js components to access the backend API; <br>
|
` ║ ║ ╠═ services/` (JS) Old Angular.js components to access the backend API; <br>
|
||||||
║ ║ ╠═ `typings/` (TS) Typed modules for non-JS/TS file types;<br>
|
` ║ ║ ╠═ typings/` (TS) Typed modules for non-JS/TS file types;<br>
|
||||||
║ ║ ╠═ `app.js` Entrypoint for the angular.js application;<br>
|
` ║ ║ ╠═ app.js` Entrypoint for the angular.js application;<br>
|
||||||
║ ║ ╠═ `plugins.js.erb` Entrypoint for embedding Fab-manager's plugins in the frontend application;<br>
|
` ║ ║ ╠═ plugins.js.erb` Entrypoint for embedding Fab-manager's plugins in the frontend application;<br>
|
||||||
║ ║ ╚═ `router.js` Configuration for UI-Router (mapping between routes, controllers and templates)<br>
|
` ║ ║ ╚═ router.js` Configuration for UI-Router (mapping between routes, controllers and templates)<br>
|
||||||
║ ╚═ `stylesheets/` SASS source for the application style<br>
|
` ║ ╚═ stylesheets/` SASS source for the application style<br>
|
||||||
╚═ `templates/` Angular.js views (HTML)
|
` ╚═ templates/` Angular.js views (HTML)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user