Skip to content
This repository has been archived by the owner on Jul 31, 2024. It is now read-only.

Commit

Permalink
monorepo Remove TS shims and remove CSS references from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NikhilVerma committed Oct 9, 2023
1 parent 1a81a22 commit d4fd564
Show file tree
Hide file tree
Showing 11 changed files with 10 additions and 217 deletions.
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,13 @@ Flow-core is the base library required by any flow dependecies. It consists most
- [Website](https://flow.cldcvr.com/)
- [Learn More](https://github.com/cldcvr/flow-core/blob/main/ABOUT.md)

**Table of contents**
## Table of contents

- [Starter-kits](#starter-kits)
- [Install for an existing project](#existing-project)
- [VScode Plugin and debuggers](#vscode-plugin-and-debuggers)
- [Components](https://flow.cldcvr.com/v2/index.html)
- [Templates](https://flow.cldcvr.com/templates/index.html)
- [Dependencies](#dependencies)
- [Lineage](https://github.com/cldcvr/flow-lineage)
- [Form builder](https://github.com/cldcvr/flow-form-builder)
- [Resources](#resources)
- [Figma for designers](https://www.figma.com/community/file/1240565037876928288/Flow-UI-Kit)
- [Get in touch](#get-in-touch)
Expand Down Expand Up @@ -53,33 +50,7 @@ _Note:_ after installation re-start your application.

<br>

#### 2️⃣ Import CSS

**Vue:**
Paste the below snippet _after the closing `<template>`_ in your `App.vue`

```html
<style>
@import "@cldcvr/flow-core/dist/style.css";
</style>
```

**React:** Paste the below snippet in `src/index.tsx` or `index.jsx`

```JavaScript
import "@cldcvr/flow-core/dist/style.css";
```

**Angular:** Add css file path in `angular.json` in `styles` property array.

```JSON
"styles": ["@cldcvr/flow-core/dist/style.css"],

```

<br>

#### 3️⃣ Import flow-core into your project
#### 2️⃣ Import flow-core into your project

Copy and import the below snippet into your startup file. In **VueJS:** (src/main.ts or main.js), **Angular:** (src/main.ts), **React:** (src/index.tsx or index.jsx)

Expand All @@ -91,9 +62,7 @@ import("@cldcvr/flow-core").then(async () => {

<br>

#### 4️⃣ If your project is typescript enabled please include import types to

**Note:** For Typescript, make sure you are using version >4.5
#### 3️⃣ If your project uses Typescript (>4.5) please include import types

**Vue:**
Copy paste below line in your `main.ts` file.
Expand Down Expand Up @@ -154,8 +123,6 @@ Visit the [Flow templates Storybook](https://flow.cldcvr.com/templates/index.htm

## Dependencies

- [Lineage](https://github.com/cldcvr/flow-lineage)
- [Form builder](https://github.com/cldcvr/flow-form-builder)
- Tables (In development)
- Logs (coming soon)
- Force graph (coming soon)
Expand Down
4 changes: 1 addition & 3 deletions docs/nuxt3-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ export default defineNuxtPlugin({
await Promise.all([
import("@cldcvr/flow-core"),
import("@cldcvr/flow-form-builder"),
import("@cldcvr/flow-system-icon"),
import("@cldcvr/flow-core/dist/style.css"),
import("@cldcvr/flow-form-builder/dist/style.css")
import("@cldcvr/flow-system-icon")
]).then(() => {
console.log("Flow components loaded");
});
Expand Down
38 changes: 2 additions & 36 deletions packages/flow-code-editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,41 +14,7 @@ npm i --save @cldcvr/flow-code-editor

<br>

### 2️⃣ Import styles/CSS

For **Vue JS:**
Paste the below snippet after the closing `<template>` tag in your `App.vue` file

```html
<style>
@import "@cldcvr/flow-code-editor/dist/style.css";
</style>
```

<details>
<summary>For React</summary>

**React:** Paste the below snippet in `src/index.tsx` or `index.jsx` file

```Javascript
import "@cldcvr/flow-code-editor/dist/style.css";
```

</details>

<details><summary>For Angular</summary>

**Angular:** Add css file path in `angular.json` in `styles` property array.

```json
"styles": ["@cldcvr/flow-code-editor/dist/style.css"],
```

</details>

<br>

### 3️⃣ Import flow-code-editor into your project
### 2️⃣ Import flow-code-editor into your project

Paste the below snippet in your project and add your application startup/runtime code to it.

Expand Down Expand Up @@ -86,7 +52,7 @@ Paste the below snippet in your project, for `src/index.tsx` or `index.jsx`

<br>

### 4️⃣ For a typescript enabled project (optional)
### 3️⃣ For a typescript enabled project (optional)

**Note:** After adding, re-start your application. Make sure you are using version >4.5

Expand Down
12 changes: 0 additions & 12 deletions packages/flow-code-editor/src/shims.d.ts

This file was deleted.

14 changes: 0 additions & 14 deletions packages/flow-form-builder/src/shims.d.ts

This file was deleted.

14 changes: 0 additions & 14 deletions packages/flow-lineage/src/shims.d.ts

This file was deleted.

12 changes: 0 additions & 12 deletions packages/flow-log/src/shims.d.ts

This file was deleted.

38 changes: 2 additions & 36 deletions packages/flow-md-editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,41 +14,7 @@ npm i --save @cldcvr/flow-md-editor

<br>

### 2️⃣ Import styles/CSS

For **Vue JS:**
Paste the below snippet after the closing `<template>` tag in your `App.vue` file

```html
<style>
@import "@cldcvr/flow-md-editor/dist/style.css";
</style>
```

<details>
<summary>For React</summary>

**React:** Paste the below snippet in `src/index.tsx` or `index.jsx` file

```Javascript
import "@cldcvr/flow-md-editor/dist/style.css";
```

</details>

<details><summary>For Angular</summary>

**Angular:** Add css file path in `angular.json` in `styles` property array.

```json
"styles": ["@cldcvr/flow-md-editor/dist/style.css"],
```

</details>

<br>

### 3️⃣ Import flow-md-editor into your project
### 2️⃣ Import flow-md-editor into your project

Paste the below snippet in your project and add your application startup/runtime code to it.

Expand Down Expand Up @@ -86,7 +52,7 @@ Paste the below snippet in your project, for `src/index.tsx` or `index.jsx`

<br>

### 4️⃣ For a typescript enabled project (optional)
### 3️⃣ For a typescript enabled project (optional)

**Note:** After adding, re-start your application. Make sure you are using version >4.5

Expand Down
9 changes: 0 additions & 9 deletions packages/flow-md-editor/src/shims.d.ts

This file was deleted.

38 changes: 2 additions & 36 deletions packages/flow-table/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,41 +14,7 @@ npm i --save @cldcvr/flow-table

<br>

### 2️⃣ Import styles/CSS

For **Vue JS:**
Paste the below snippet after the closing `<template>` tag in your `App.vue` file

```html
<style>
@import "@cldcvr/flow-table/dist/style.css";
</style>
```

<details>
<summary>For React</summary>

**React:** Paste the below snippet in `src/index.tsx` or `index.jsx` file

```Javascript
import "@cldcvr/flow-table/dist/style.css";
```

</details>

<details><summary>For Angular</summary>

**Angular:** Add css file path in `angular.json` in `styles` property array.

```json
"styles": ["@cldcvr/flow-table/dist/style.css"],
```

</details>

<br>

### 3️⃣ Import flow-table into your project
### 2️⃣ Import flow-table into your project

Paste the below snippet in your project and add your application startup/runtime code to it.

Expand Down Expand Up @@ -86,7 +52,7 @@ Paste the below snippet in your project, for `src/index.tsx` or `index.jsx`

<br>

### 4️⃣ For a typescript enabled project (optional)
### 3️⃣ For a typescript enabled project (optional)

**Note:** After adding, re-start your application. Make sure you are using version >4.5

Expand Down
9 changes: 0 additions & 9 deletions packages/flow-table/src/shims.d.ts

This file was deleted.

0 comments on commit d4fd564

Please sign in to comment.