Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor code folder structure #394

Merged
merged 3 commits into from
Jan 14, 2020
Merged

Refactor code folder structure #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31f1c28
refactor(*): move to new folder structure splitting core and features
sleidig Jan 10, 2020
f2aa807
refactor(*): fixed typos and unnecessary imports
sleidig Jan 10, 2020
e8ca78b
refactor(*): tslint for consistent whitespace in imports and trailing…
sleidig Jan 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Our detailed documentation and API reference is hosted on GitHub Pages: [**aam-d

Additionally you can find guides and recipes to implement common functionalities there in the [Developer Documentation](http://aam-digital.github.io/ndb-core/additional-documentation/guidelines-and-recipes.html).

The application code is split within the `src/app/` directory into modules providing
general features and abstract components (_core_) and
concrete feature modules for users' use cases (_child-dev-project_).


## Setup
The project depends on a couple of tools which are required for development. Please make sure you have the following installed:
Expand Down
5 changes: 5 additions & 0 deletions doc/compodoc_sources/architecture/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ An actual, specific software system to be used will be based on the core and ext

## EntitySchema System
see [Entity Schema System](./architecture/entity-schema.html)

## Folder Structure
The application code is split within the `src/app/` directory into modules providing
general features and abstract components (_core_) and
concrete feature modules for users' use cases (currently only _child-dev-project_).
2 changes: 1 addition & 1 deletion doc/compodoc_sources/first-steps/first-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This wiki serves as the place for all development related documentation.

## Getting started with coding
1. Don't get overwhelmed by the mass of config files in the root directory. Jump directly to the subfolder [src/app/](https://github.com/NGO-DB/ndb-core/tree/master/src/app) where the actually relevant code is located. (If you are completely new to Angular, maybe make yourself familiar with the basic structure and approach first: [Angular - Getting started](https://angular.io/guide/quickstart))
2. The project is structured into several Modules, each in its own folder under src/app/
2. The project is structured into several Modules, each in its own folder under src/app/core (general features) or src/app/child-ded-project (special user-facing features)
3. To extend upon the existing system, don't worry about the lower layer modules. Focus on understanding the top level modules adding user features like the `SchoolModule` and the `ChildrenModule`.
Loading