https://github.com/flaque/sea-floor
https://github.com/flaque/sea-floor
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/flaque/sea-floor
- Owner: Flaque
- Created: 2017-08-13T03:56:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-01T19:52:01.000Z (over 7 years ago)
- Last Synced: 2025-01-20T10:13:53.808Z (4 months ago)
- Language: JavaScript
- Size: 264 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌊 sea-floor
Sea-floor is [a magic little](https://www.youtube.com/watch?v=GC_mV1IpjWA) library that makes building electron apps in React super duper easy.
In fact, your entire electron app can be:
``` js
import Sea from 'sea-floor';
import path from 'path';
Sea.open(path.join(__dirname, "./path/to/react/component.js"));
```
Install it in your project and globally with:
``` sh
$ npm install --save sea-floor@latest
$ npm install -g sea-floor@latest
```
Then run your app with:
``` sh
$ sea path/to/file.js
```
## Status
Sea-floor is still being developed at the moment. If you're curious, you can try it out for yourself! Otherwise it might be a good idea to not build anything on top of this at the moment.
## TODO
- Update the test suite
- Add better docs
- Figure out a proper way of handling styles
- Add hot code reloading
- Figure out a way to take in components instead of filepaths (ie: `Sea.open()` )
- Add an "escape hatch" that lets people add their own webpack config if they would like