-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 05c86ff
Showing
162 changed files
with
9,112 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
node_modules | ||
dist | ||
build | ||
|
||
**/node_modules | ||
**/build | ||
**/dist |
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,28 @@ | ||
module.exports = { | ||
extends: [ | ||
'eslint:recommended', | ||
'plugin:markdown/recommended', | ||
'plugin:react/recommended', | ||
'plugin:react/jsx-runtime', | ||
'plugin:react-hooks/recommended', | ||
'plugin:jsx-a11y/recommended', | ||
'plugin:prettier/recommended' | ||
], | ||
settings: { | ||
react: { | ||
version: 'detect' | ||
} | ||
}, | ||
parser: '@typescript-eslint/parser', | ||
ignorePatterns: ['**/node_modules', '**/dist', '**/build', '**/package-lock.json'], | ||
plugins: ['unused-imports'], | ||
rules: { | ||
'@typescript-eslint/explicit-module-boundary-types': 'off', | ||
'no-unused-vars': 'off', | ||
'unused-imports/no-unused-imports': 'warn', | ||
'unused-imports/no-unused-vars': ['warn', { vars: 'all', varsIgnorePattern: '^_', args: 'after-used', argsIgnorePattern: '^_' }], | ||
'no-undef': 'off', | ||
'no-console': [process.env.CI ? 'error' : 'warn', { allow: ['warn', 'error', 'info'] }], | ||
'prettier/prettier': 'error' | ||
} | ||
} |
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,32 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '[BUG]' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
|
||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Setup** | ||
|
||
- OS: [e.g. iOS, Windows, Linux] | ||
- Browser [e.g. chrome, safari] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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,13 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '[FEATURE]' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
**Describe the feature you'd like** | ||
A clear and concise description of what you would like Flowise to have. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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,36 @@ | ||
name: Node CI | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
pull_request: | ||
branches: | ||
- '*' | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
build: | ||
strategy: | ||
matrix: | ||
platform: [ubuntu-latest] | ||
node-version: [14.x, 16.x] | ||
runs-on: ${{ matrix.platform }} | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Use Node.js ${{ matrix.node-version }} | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: ${{ matrix.node-version }} | ||
|
||
- run: npm i -g yarn | ||
|
||
- run: yarn install --ignore-engines | ||
|
||
- run: yarn lint | ||
|
||
- run: yarn build |
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,42 @@ | ||
# editor | ||
.idea | ||
.vscode | ||
|
||
# dependencies | ||
**/node_modules | ||
**/package-lock.json | ||
**/yarn.lock | ||
|
||
## logs | ||
**/*.log | ||
|
||
## build | ||
**/dist | ||
**/build | ||
|
||
## temp | ||
**/tmp | ||
**/temp | ||
|
||
## test | ||
**/coverage | ||
|
||
# misc | ||
.DS_Store | ||
|
||
## env | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env | ||
|
||
## turbo | ||
.turbo | ||
|
||
## secrets | ||
**/*.key | ||
**/api.json | ||
|
||
## compressed | ||
**/*.tgz |
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,5 @@ | ||
#!/bin/sh | ||
. "$(dirname "$0")/_/husky.sh" | ||
|
||
yarn quick # prettify | ||
yarn lint-staged # eslint lint(also include prettify but prettify support more file extensions than eslint, so run prettify first) |
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,3 @@ | ||
**/node_modules | ||
**/dist | ||
**/build |
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,9 @@ | ||
module.exports = { | ||
printWidth: 140, | ||
singleQuote: true, | ||
jsxSingleQuote: true, | ||
trailingComma: 'none', | ||
tabWidth: 4, | ||
semi: false, | ||
endOfLine: 'auto' | ||
} |
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,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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,127 @@ | ||
<!-- markdownlint-disable MD030 --> | ||
|
||
# Contributing to Flowise | ||
|
||
We appreciate any form of contributions. | ||
|
||
## ⭐ Star | ||
|
||
Star and share the [Github Repo](https://github.com/FlowiseAI/Flowise). | ||
|
||
## 🙋 Q&A | ||
|
||
Search up for any questions in [Q&A section](https://github.com/FlowiseAI/Flowise/discussions/categories/q-a), if you can't find one, don't hesitate to create one. It might helps others that have similar question. | ||
|
||
## 🙌 Share Chatflow | ||
|
||
Yes! Sharing how you use Flowise is a way of contribution. Export your chatflow as JSON, attach a screenshot and share it in [Show and Tell section](https://github.com/FlowiseAI/Flowise/discussions/categories/show-and-tell). | ||
|
||
## 💡 Ideas | ||
|
||
Ideas are welcome such as new feature, apps integration, and blockchain networks. Submit in [Ideas section](https://github.com/FlowiseAI/Flowise/discussions/categories/ideas). | ||
|
||
## 🐞 Report Bugs | ||
|
||
Found an issue? [Report it](https://github.com/FlowiseAI/Flowise/issues/new/choose). | ||
|
||
## 👨💻 Contribute to Code | ||
|
||
Not sure what to contribute? Some ideas: | ||
|
||
- Create new components from Langchain | ||
- Update existing components such as extending functionality, fixing bugs | ||
- Add new chatflow ideas | ||
|
||
### Developers | ||
|
||
Flowise has 3 different modules in a single mono repository. | ||
|
||
- `server`: Node backend to serve API logics | ||
- `ui`: React frontend | ||
- `components`: Langchain components | ||
|
||
#### Prerequisite | ||
|
||
- Install Yarn | ||
```bash | ||
npm i -g yarn | ||
``` | ||
|
||
#### Step by step | ||
|
||
1. Fork the official [Flowise Github Repository](https://github.com/FlowiseAI/Flowise). | ||
|
||
2. Clone your forked repository. | ||
|
||
3. Create a new branch, see [guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository). Naming conventions: | ||
|
||
- For feature branch: `feature/<Your New Feature>` | ||
- For bug fix branch: `bugfix/<Your New Bugfix>`. | ||
|
||
4. Switch to the newly created branch. | ||
|
||
5. Go into repository folder | ||
|
||
```bash | ||
cd Flowise | ||
``` | ||
|
||
6. Install all dependencies of all modules: | ||
|
||
```bash | ||
yarn install | ||
``` | ||
|
||
7. Build all the code: | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
8. Start the app on [http://localhost:3000](http://localhost:3000) | ||
|
||
```bash | ||
yarn start | ||
``` | ||
|
||
9. For development, run | ||
|
||
```bash | ||
yarn dev | ||
``` | ||
|
||
Any changes made in `packages/ui` or `packages/server` will be reflected on [http://localhost:8080](http://localhost:8080) | ||
|
||
For changes made in `packages/components`, run `yarn build` again to pickup the changes. | ||
|
||
10. After making all the changes, run | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
and | ||
|
||
```bash | ||
yarn start | ||
``` | ||
|
||
to make sure everything works fine in production. | ||
|
||
11. Commit code and submit Pull Request from forked branch pointing to [Flowise master](https://github.com/FlowiseAI/Flowise/tree/master). | ||
|
||
## 📖 Contribute to Docs | ||
|
||
In-Progress | ||
|
||
## 🏷️ Pull Request process | ||
|
||
A member of the FlowiseAI team will automatically be notified/assigned when you open a pull request. You can also reach out to us on [Discord](https://discord.gg/GWcGczPk). | ||
|
||
## 📃 Contributor License Agreement | ||
|
||
Before we can merge your contribution you have to sign our [Contributor License Agreement (CLA)](https://cla-assistant.io/FlowiseAI/Flowise). The CLA contains the terms and conditions under which the contribution is submitted. You need to do this only once for your first pull request. Keep in mind that without a signed CLA we cannot merge your contribution. | ||
|
||
## 📜 Code of Conduct | ||
|
||
This project and everyone participating in it are governed by the Code of Conduct which can be found in the [file](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]. |
Oops, something went wrong.