https://github.com/chrisru/beight-client
✏️ Frontend for a collaborative web editor
https://github.com/chrisru/beight-client
babel es6 eslint monaco-editor preact webpack websocket
Last synced: about 2 months ago
JSON representation
✏️ Frontend for a collaborative web editor
- Host: GitHub
- URL: https://github.com/chrisru/beight-client
- Owner: ChrisRu
- License: mit
- Created: 2017-08-19T11:09:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-22T18:43:58.000Z (over 7 years ago)
- Last Synced: 2025-02-11T08:29:00.633Z (4 months ago)
- Topics: babel, es6, eslint, monaco-editor, preact, webpack, websocket
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Beight Client
A collaborative web editor built with Preact and Monaco Editor.
This is the frontend for the Beight application. If you want the full experience, go to https://github.com/ChrisRu/beight-core and install the backend/API.
## Setup
1. Install the node modules
`npm install`
2. Done :)
## Running
1. Start the development server
`npm run watch`
2. The application should start after a few seconds. Press CTRL+C to exit.
## Collaboration
### Folder Structure
#### The root should look like this:
```
/
/actions
/components
/scenes
/services
/styles
/reducers
index.js
```
`/actions` contains the redux actions
`/components` contains one or more 'components' (see below)
`/scenes` contains all the main 'views'
`/services` contains global methods/services
`/styles` contains the global styles used all over the application
`/reducers` contains the redux reducers
`index.js` is the starting point of the application
#### A component should look like this
```
/
/components
/services
index.js
styles.scss
```
`/components` (optional) contains components (a recursive file structure)
`/services` (optional) contains methods/services you don't want to include in the component itself
`index.js` is the component itself
`styles.scss` (optional) is the styles only used in this component
## License
This application is MIT licensed