Skip to content

Base project structure

Jan Pánek edited this page Aug 8, 2021 · 3 revisions

Structure of the root folder is like any other Angular project, the 2 most important folders are:

/docs

This is the folder with production build of the whole project, and the one that is being served on GitHub pages.

Note that changes made to the project will not be seen unless the owner makes a production build and pushes it to GitHub. To learn more, see How to contribute section.

/src

This is where the real application is. The rest of the folders will be relative to this folder.

Folder Description
/app The core component, any other pages or services are made within this folder.
/assets Any images, icons, gifs and videos go there.
/interfaces This folder is used for interfaces of logic components. More on that in Component Structure section.
/models Anything related to the logic of the components or the components themselves.
/shared Anything that is globally used in any part of the application. (methods, classes...)
/app/pages Pages without much functionality go there (landing page for example)
/app/board The main board component and anything related to it is found there.
/app/board/components The UI representation of the components goes there.
/styles.scss These are global styles that can applied to any component. All css colors can be found there

This is the basic structure of the project, not all is covered because some things are self explanatory and don't need any further description. The next section will cover the Component structure