mirror of
https://github.com/fluencelabs/fluent-pad
synced 2025-04-25 08:52:14 +00:00
Add more sensible readme
This commit is contained in:
parent
0ff0325392
commit
83cbb62ccd
52
README.md
52
README.md
@ -1,46 +1,32 @@
|
|||||||
# Getting Started with Create React App
|
# What is fluent-pad
|
||||||
|
|
||||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
Fluent-pad is a collaborative code and text editor built with Fluence stack
|
||||||
|
|
||||||
## Available Scripts
|
## Usage
|
||||||
|
|
||||||
In the project directory, you can run:
|
**TBD**
|
||||||
|
|
||||||
### `npm start`
|
## How to run
|
||||||
|
|
||||||
Runs the app in the development mode.\
|
To run app in the development mode use:
|
||||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
|
||||||
|
|
||||||
The page will reload if you make edits.\
|
npm start
|
||||||
You will also see any lint errors in the console.
|
|
||||||
|
|
||||||
### `npm test`
|
To run tests in the interactive watch mode use:
|
||||||
|
|
||||||
Launches the test runner in the interactive watch mode.\
|
npm test
|
||||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
|
||||||
|
|
||||||
### `npm run build`
|
To make a production build use:
|
||||||
|
|
||||||
Builds the app for production to the `build` folder.\
|
npm run build
|
||||||
It correctly bundles React in production mode and optimizes the build for the best performance.
|
|
||||||
|
|
||||||
The build is minified and the filenames include the hashes.\
|
# Fluence stack
|
||||||
Your app is ready to be deployed!
|
|
||||||
|
|
||||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
| Layer | Tech | Scale | State | Based on |
|
||||||
|
| :-------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------: | :-------------------------------: | :-----------------------------------------------------------------------------------------------------------: |
|
||||||
|
| Execution | [FCE](https://github.com/fluencelabs/fce) | Single peer | Disk, network, external processes | Wasm, [IT](https://github.com/fluencelabs/interface-types), [Wasmer\*](https://github.com/fluencelabs/wasmer) |
|
||||||
|
| Composition | [Aquamarine](https://github.com/fluencelabs/aquamarine) | Involved peers | Results and signatures | ⇅, π-calculus |
|
||||||
|
| Topology | [TrustGraph](https://github.com/fluencelabs/fluence/tree/master/trust-graph), [DHT\*](https://github.com/fluencelabs/rust-libp2p) | Distributed with Kademlia\* algo | Actual state of the network | [libp2p](https://github.com/libp2p/rust-libp2p) |
|
||||||
|
| Security & Accounting | Blockchain | Whole network | Licenses & payments | substrate? |
|
||||||
|
|
||||||
### `npm run eject`
|
<img alt="aquamarine scheme" align="center" src="doc/stack.png"/>
|
||||||
|
|
||||||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
|
||||||
|
|
||||||
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
|
|
||||||
|
|
||||||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
|
|
||||||
|
|
||||||
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
|
|
||||||
|
|
||||||
## Learn More
|
|
||||||
|
|
||||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
|
||||||
|
|
||||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
|
||||||
|
BIN
doc/stack.png
Normal file
BIN
doc/stack.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 83 KiB |
Loading…
x
Reference in New Issue
Block a user