https://github.com/odeum/odeum-code-lite
An ODEUM Code scaled down getting-started quickly boilerplate
https://github.com/odeum/odeum-code-lite
Last synced: 6 months ago
JSON representation
An ODEUM Code scaled down getting-started quickly boilerplate
- Host: GitHub
- URL: https://github.com/odeum/odeum-code-lite
- Owner: odeum
- Created: 2017-10-24T14:39:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-29T11:56:39.000Z (almost 7 years ago)
- Last Synced: 2025-06-04T18:54:42.989Z (7 months ago)
- Language: JavaScript
- Homepage: http://odeumcode.com
- Size: 1.04 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# odeum-code-lite
A scaled down "ODEUM Code" getting-started quickly framework
## Components:
- AppContainer
- Header
- MenuPanel
- Menu
- Tab
- Workspace
- Footer
- Logo
```js
import { AppContainer, Header, MenuPanel, Menu, Tab, Workspace, Footer, registerHotModule } from 'odeum-app'
import { Button, ButtonPanel, Modal, Dropdown, Input, Checkbox, ToggleSwitch } from 'odeum-ui'
import { Heading, Text } from 'odeum-primitives'
```
## Added by you:
- ODEUM UI
- ODEUM Primitives
- Redux
- Routes
- Whatever ...
### Theme
Default theme is ODEUM Code theme. The theme file contains objects for colors, fonts and sizes for the selected theme.
A theme is passed as a theme prop to the component.
If no theme is provided to the AppContainer by the user, the AppContainer loads the default theme provided in the odeum-app package.
```js
import theme from './theme/bluehorizon.js'
...
```
We might provide setTheme and getTheme functions to pattern check the contents of the theme file to ensure that the objects contains the required values.
## Configuration:
All components exported from **odeum-ui** and **odeum-app** has propTypes and defaultProps.
All defaultProps are loaded with default values so a fully scaled down App template will look like this:
[App_default.js](./src/App_default.js)
A template with named values and more props passed would look like this:
[App_normal.js](./src/App_normal.js)
### Logo
Default logo is odeumcode_logo.svg which is loaded default by Header component unless it is overwritten by the Header prop "logo={'pathtologo.svg'}"
- JSON config file(s) - footer etc. or style objects.
### Workspace components can be functional components (render props) or class components.
## Routing
Routing will be encapsulated and processed by the routable components through a route prop. The routable components are:
- AppContainer (makes the logo routable)
- Menu
- Tab
Examples:
```js
```
## 404 - Page Not Found!