Verified Commit 2de8cb67 authored by Sandro Lutz's avatar Sandro Lutz
Browse files

Update Readme

parent 8162b41d
Pipeline #58025 failed with stages
in 10 minutes and 1 second
......@@ -54,10 +54,11 @@ A quick look at the most important files and directories of the project.
├── config.production.js
└── src
├── components
├── content
├── context
├── hooks
├── images
├── intl
├── markdown
├── pages
├── store
├── utils
......@@ -76,20 +77,21 @@ A quick look at the most important files and directories of the project.
6. **`/src`**: This directory contains all source code.
1. **`/src/components`**: This directory contains all components used somewhere on the website.
2. **`/src/context`**: This directory contains all custom [React Context](https://reactjs.org/docs/context.html)
3. **`/src/images`**: This directory contains all static images.
4. **`/src/intl`**: This directory contains all translation files used by `react-intl`.
5. **`/src/markdown`**: This directory contains markdown source files used on specific pages.
6. **`/src/pages`**: Every `js` file represents a page which path is exactly like the folder structure and filename.
1. **`/src/components`**: Contains all components used somewhere on the website.
2. **`/src/content`**: All content only files (e.g. board or teams portraits or static texts)
3. **`/src/context`**: Custom [React Context](https://reactjs.org/docs/context.html)
4. **`/src/hooks`**: Custom React hooks.
5. **`/src/images`**: Static images.
6. **`/src/intl`**: Translation files used by `react-intl`.
7. **`/src/pages`**: Every `js` file represents a page which path is exactly like the folder structure and filename.
**Note**: Every file starting with an underscore (`_`) in the pages directory is ignored. Those pages are mostly being used for client-only routes. Therefore no page route is created and no server-side rendering performed.
**Note**: Every file starting with an underscore (`_`) in the pages directory is ignored. Those pages are mostly being used for client-only routes. Therefore no page route is created and no server-side rendering performed.
_Example: The file `/src/pages/amiv/about.js` will serve the component defined in that file as a page at the path `/amiv/about`._
_Example: The file `/src/pages/amiv/about.js` will serve the component defined in that file as a page at the path `/amiv/about`._
7. **`/src/store`**: This directory contains all files related to data handling using `react-redux`.
8. **`/src/utils`**: Collection of utility functions.
9. **`/src/theme.js`**: Theme definition for light/dark mode (dimensions, colors, etc.)
8. **`/src/store`**: This directory contains all files related to data handling using `react-redux`.
9. **`/src/utils`**: Collection of utility functions.
10. **`/src/theme.js`**: Theme definition for light/dark mode (dimensions, colors, etc.)
## 💫 Deployment
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment