This repository has been archived by the owner on Jul 31, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FLOW-952 FLOW-953 Stories are organized based on priority, with an 'A…
…bout' story included for each package. (#199) * FLOW-952 FLOW_952 FLOW-953 stories sorted as per priority+ About story added for each package * FLOW-952 FLOW_952 FLOW-953 stories sorted as per priority+ About story added for each package
- Loading branch information
1 parent
ac417c6
commit 9c5c501
Showing
34 changed files
with
477 additions
and
391 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Flow Log | ||
|
||
The Flow Log is built on the Flow design framework ([website](https://flow.ollion.com/) / [github](https://github.com/cldcvr/flow-core)) using [Monaco Editor](https://microsoft.github.io/monaco-editor/) | ||
|
||
# Installation | ||
|
||
### 1️⃣ Install flow code editor dependency | ||
|
||
``` | ||
npm i --save @cldcvr/flow-log | ||
``` | ||
|
||
**Note:** after installation, re-start your application. | ||
|
||
<br> | ||
|
||
### 2️⃣ Import flow-log into your project | ||
|
||
Paste the below snippet in your project and add your application startup/runtime code to it. | ||
|
||
```javascript | ||
import "@cldcvr/flow-core"; | ||
import "@cldcvr/flow-log"; | ||
``` | ||
|
||
<br> | ||
|
||
### 3️⃣ For a typescript enabled project (optional) | ||
|
||
**Note:** After adding, re-start your application. Make sure you are using version >4.5 | ||
|
||
**For Vue 3:** | ||
Copy paste below import types in your `main.ts` file. | ||
|
||
```Javascript | ||
import "@cldcvr/flow-log/dist/types/vue3"; | ||
``` | ||
|
||
<details> | ||
<summary>For Vue 2</summary> | ||
|
||
Copy paste below import types in your `main.ts` file. | ||
|
||
```Javascript | ||
import "@cldcvr/flow-log/dist/types/vue2"; | ||
``` | ||
|
||
</details> | ||
|
||
<details> | ||
<summary>For React</summary> | ||
|
||
**React**: Include react type in `tsconfig.json` file like below. | ||
|
||
```json | ||
"include": ["src", "./node_modules/@cldcvr/flow-log/dist/types/react.ts"] | ||
``` | ||
|
||
</details> | ||
<br> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.