diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 43f82993..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -English | [中文](<./CODE_OF_CONDUCT-ZH.md>) - -## 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 hello@flowiseai.com. 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/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index db4301da..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,160 +0,0 @@ - - -# Contributing to Flowise - -English | [中文](./CONTRIBUTING-ZH.md) - -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 v1](https://classic.yarnpkg.com/en/docs/install) - ```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/` - - For bug fix branch: `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: - - - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/ui` - - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server` - - 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). - -## 🌱 Env Variables - -Flowise support different environment variables to configure your instance. You can specify the following variables in the `.env` file inside `packages/server` folder. Read [more](https://docs.flowiseai.com/environment-variables) - -| Variable | Description | Type | Default | -| --------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- | --- | -| PORT | The HTTP port Flowise runs on | Number | 3000 | -| FLOWISE_USERNAME | Username to login | String | | -| FLOWISE_PASSWORD | Password to login | String | | -| DEBUG | Print logs from components | Boolean | | -| LOG_PATH | Location where log files are stored | String | `your-path/Flowise/logs` | -| LOG_LEVEL | Different levels of logs | Enum String: `error`, `info`, `verbose`, `debug` | `info` | -| APIKEY_PATH | Location where api keys are saved | String | `your-path/Flowise/packages/server` | -| TOOL_FUNCTION_BUILTIN_DEP | NodeJS built-in modules to be used for Tool Function | String | | -| TOOL_FUNCTION_EXTERNAL_DEP | External modules to be used for Tool Function | String | | | -| DATABASE_TYPE | Type of database to store the flowise data | Enum String: `sqlite`, `mysql`, `postgres` | `sqlite` | -| DATABASE_PATH | Location where database is saved (When DATABASE_TYPE is sqlite) | String | `your-home-dir/.flowise` | -| DATABASE_HOST | Host URL or IP address (When DATABASE_TYPE is not sqlite) | String | | -| DATABASE_PORT | Database port (When DATABASE_TYPE is not sqlite) | String | | -| DATABASE_USER | Database username (When DATABASE_TYPE is not sqlite) | String | | -| DATABASE_PASSWORD | Database password (When DATABASE_TYPE is not sqlite) | String | | -| DATABASE_NAME | Database name (When DATABASE_TYPE is not sqlite) | String | | -| SECRETKEY_PATH | Location where encryption key (used to encrypt/decrypt credentials) is saved | String | `your-path/Flowise/packages/server` | -| FLOWISE_SECRETKEY_OVERWRITE | Encryption key to be used instead of the key stored in SECRETKEY_PATH | String | - -You can also specify the env variables when using `npx`. For example: - -``` -npx flowise start --PORT=3000 --DEBUG=true -``` - -## 📖 Contribute to Docs - -[Flowise Docs](https://github.com/FlowiseAI/FlowiseDocs) - -## 🏷️ 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/jbaHfsRVBW). - -## 📜 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 hello@flowiseai.com. diff --git a/docker/README.md b/docker/README.md index d3ad1c19..691f2771 100644 --- a/docker/README.md +++ b/docker/README.md @@ -6,18 +6,18 @@ Starts Flowise from [DockerHub Image](https://hub.docker.com/repository/docker/f 1. Create `.env` file and specify the `PORT` (refer to `.env.example`) 2. `docker-compose up -d` -3. Open [http://localhost:3000](http://localhost:3000) +3. Open [http://localhost:8080](http://localhost:8080) 4. You can bring the containers down by `docker-compose stop` ## 🔒 Authentication -1. Create `.env` file and specify the `PORT`, `FLOWISE_USERNAME`, and `FLOWISE_PASSWORD` (refer to `.env.example`) -2. Pass `FLOWISE_USERNAME` and `FLOWISE_PASSWORD` to the `docker-compose.yml` file: +1. Create `.env` file and specify the `PORT`, `Vectrflow_USERNAME`, and `Vectrflow_PASSWORD` (refer to `.env.example`) +2. Pass `Vectrflow_USERNAME` and `Vectrflow_PASSWORD` to the `docker-compose.yml` file: ``` environment: - PORT=${PORT} - - FLOWISE_USERNAME=${FLOWISE_USERNAME} - - FLOWISE_PASSWORD=${FLOWISE_PASSWORD} + - Vectrflow_USERNAME=${Vectrflow_USERNAME} + - Vectrflow_PASSWORD=${Vectrflow_PASSWORD} ``` 3. `docker-compose up -d` 4. Open [http://localhost:3000](http://localhost:3000) @@ -32,4 +32,4 @@ If you like to persist your data (flows, logs, apikeys, credentials), set these - LOG_PATH=/root/.flowise/logs - SECRETKEY_PATH=/root/.flowise -Flowise also support different environment variables to configure your instance. Read [more](https://docs.flowiseai.com/environment-variables) + diff --git a/packages/ui/src/ui-component/dialog/AboutDialog.js b/packages/ui/src/ui-component/dialog/AboutDialog.js index 4f480a58..dea735b7 100644 --- a/packages/ui/src/ui-component/dialog/AboutDialog.js +++ b/packages/ui/src/ui-component/dialog/AboutDialog.js @@ -23,7 +23,7 @@ const AboutDialog = ({ show, onCancel }) => { password } } - const latestReleaseReq = axios.get('https://api.github.com/repos/FlowiseAI/Flowise/releases/latest') + const latestReleaseReq = axios.get('https://github.com/vgees/VectrFlow') const currentVersionReq = axios.get(`${baseURL}/api/v1/version`, { ...config }) Promise.all([latestReleaseReq, currentVersionReq]) @@ -52,7 +52,7 @@ const AboutDialog = ({ show, onCancel }) => { aria-describedby='alert-dialog-description' > - Flowise Version + VectrFlow Version {data && (