Skip to content

Commit c00d68b

Browse files
authored
added readme (#81)
1 parent bc671ed commit c00d68b

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Project Structure Draft:
2+
3+
```
4+
.
5+
├── firebase.js // handles fetching and saving to the realtime database on firebase
6+
├── firebase.json // used for firebase deploy
7+
├── index.html // the main index page - contains header and loads the index.jsx
8+
├── package.json // used for nodejs (npm) packages
9+
├── package-lock.json // used for nodejs (npm) packages
10+
├── README.md // this file ^^
11+
├── src // contains all source filed
12+
│   ├── assets // content, e.g. pictures, ressources etc.
13+
│   │   └── react.svg
14+
│   ├── index.jsx // the react router - routes between pages, all pages are inserted here
15+
│   ├── model.js // the model - handles prog. logic, that is either global or account specific
16+
│   ├── pages // pages combine the presenters to a webpage. mby obsolete for 1 page project
17+
│   │   └── App.jsx // The future homepage?
18+
│   ├── presenters // Presenters link views and the model.
19+
│   | Hooks to modify the model & component state is defined here
20+
│   │   └── HandleSearchPresenter.jsx // An example presenter
21+
│   ├── styles.css // a style document - mby one for each view?
22+
│   └── views // views define parts of pages cosmetically.
23+
│   └── DummyView.jsx
24+
└── vite.config.js
25+
```
26+
27+

0 commit comments

Comments
 (0)