Skip to content

Commit

Permalink
Folder Structure Convenstion extracted from Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
cbroberg committed Apr 11, 2017
1 parent 745b982 commit d601cfb
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 81 deletions.
80 changes: 0 additions & 80 deletions docs/Guidelines.md
Expand Up @@ -31,83 +31,3 @@ Initially we pull and commit work to 3 branches:

* <a href="./developer/odeum-codejs-branching-strategy.png" target="_blank">ODEUM CodeJS Branching Strategy</a>

## Folder structure

## Source files

```
/
/src
/src/containers
/src/components
/src/components/Header
/src/components/Header/HeaderLogo
/src/data (/models)
/src/scenes (/routes)
/src/services
/src/services/api
/src/services/geolocation
````

## Public static source files
```
/public
/public/index.html
/public/favicon.ico
```

## Example component structure

```
/
/src
/App.js
/index.js
/containers
/HeaderNotifications
/index.js
/actions.js
/reducer.js
/styles.js
/actiontypes.js
```

## Example scene structure for ODEUM Report Web App

```
/src
/assets/
/containers/
/components/
/scenes/
/Login
/Home
/scenes
/Dashboard
/Tasks
/containers
Smart1/
/actions/
/reducers/
/assets/
index.js
/components/
Dumb1/
/assets/
/styles/
index.js
Dumb2/index.js
/actions/actiontypes.js
/reducers
/styles
/Forms
/Reports
/Organisation
/Settings
/AddMenu
/AppMarket
/store/
/reducers/
/services/
/api/
```
58 changes: 58 additions & 0 deletions docs/developer/Folder-structure.md
@@ -0,0 +1,58 @@
# Folder Structure Convention

## Source files

## Public static source files
```
/public
/public/index.html
/public/favicon.ico
```

## Folder Structure Convention example for ODEUM Report Web App

```javascript
/src/
/assets/
/containers/
/components/
/scenes/
/Login/
/Home/
/scenes/
/Dashboard/
/Tasks/
/containers/
Smart1/
/actions/
smart1action.js
/reducers/
smart1reducer.js
/assets/
index.js
/components/
Dumb1/
/assets/
/styles/
index.js
Dumb2/
index.js
/actions/
actiontypes.js
/reducers/
/styles/
/Forms/
/Reports/
/Organisation/
/Settings/
/AddMenu/
/AppMarket/
/store/
store.js
/reducers/
reducers.js
/services/
/api/
/geolocation/
```

9 changes: 8 additions & 1 deletion docs/developer/Future-technology.md
@@ -1,9 +1,16 @@
# Future Technology for ODEUM CodeJS

SS: Server-side
CS: Client-side

## Relay + GraphQL
Is a possibility to use instead of Redux and Actions (services) to get and store data and manage state.

## State Recorder (Time Travel)
## State Recorder (Time Travel) (SS/CS)
A system to remotely record the client app state history so you will be able to time travel the client solution in a support/error finding prespective. The state history should be stored in a client app database.

Check NPM (redux-state-history, redux-dev-tools, redux-test-recorder)

## Data Branching (SS)
We need to be able to branch (versioning) data in our databases so we have the ability to work with "DEVDATA" and "MASTERDATA" during development and test. Users will be able to "check-out" data from the MASTERDATA into the DEVDATA branch and work with the data from there. When done working with a "record" or "structure" the user can commit the DEVDATA data to the MASTERDATA branch. The different data-branches need to be accesible to our data-synchronizers in ODEUM Sync Manager (OSM).

Binary file removed docs/~$pComponents.docx
Binary file not shown.

0 comments on commit d601cfb

Please sign in to comment.