minor overview of the folder structure for frontend

pull/3341/head
Florian Kraft 9 years ago
parent 8b860a43a3
commit 6d36b4f98a
  1. 16
      frontend/doc/OVERVIEW.md
  2. 1
      frontend/doc/README.md

@ -1,9 +1,9 @@
Development overview
====================
This should give an idea about the contents of the `./frontend` folder.
This should give an idea about the contents of the `./frontend` folder. Most of what you find here is an amalgamation of [AngularJS](https://angularjs.org) and JQuery, as well as a good list of libraries used to ease the process of development.
This is the general structure (:
This is the general structure (to a depth of 3 folders):
```
├── app
@ -31,7 +31,7 @@ This is the general structure (:
     ├── helpers
     ├── models
     └── services
   ├── [ 12K] ui_components
   ├── ui_components
     ├── date
     └── filters
   └── work_packages
@ -61,3 +61,13 @@ This is the general structure (:
   ├── reports
   └── tests
```
## The `app` folder
This is where most of the magic happens. Contains all of the production relevant code for excuting the individual parts of the frontend. Does __not__ contain the test code.
The `app` folder is furthermore divided into:
- `work_packages` contains all the specific sources for the Work Package list and the attached details pane, as well as the full screen view
- `timelines` contains all code necessary for project timelines
- `time_entries` contains a single controller used in the timelog views
- all the rest of the folders containing common components divided by their type

@ -29,3 +29,4 @@ The individual topic for the documentation fo the frontend are
- OVERVIEW.md - a general overview on the folder structure and a general "what is where"
- TESTING.md - documentation of our approach to integration and unit testing
- STYLING.md - notes on styling and the Sass-Pipeline
- RAILS.md - an overview for the frontend parts still left in the Rails stack (mostly the JavaScript

Loading…
Cancel
Save