mirror of
https://github.com/reconurge/flowsint.git
synced 2026-03-12 01:44:42 -05:00
feat: update readme
This commit is contained in:
3
Makefile
3
Makefile
@@ -75,3 +75,6 @@ clean:
|
||||
rm -rf $(PROJECT_ROOT)/flowsint-core/.venv
|
||||
rm -rf $(PROJECT_ROOT)/flowsint-transforms/.venv
|
||||
rm -rf $(PROJECT_ROOT)/flowsint-api/.venv
|
||||
|
||||
|
||||
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
|
||||
|
||||
12
README.md
12
README.md
@@ -38,18 +38,12 @@ flowsint-types (types)
|
||||
- Poetry (for dependency management)
|
||||
- Docker (for some tools)
|
||||
|
||||
### Installation
|
||||
### Run
|
||||
|
||||
1. Run the install script
|
||||
For now, you can start flowsint in a development environment. It's pretty performant already ! And fully local stored. Make sure you have **Make** installed.
|
||||
|
||||
```bash
|
||||
chmod +x ./install.sh
|
||||
```
|
||||
|
||||
### Run the services
|
||||
|
||||
```bash
|
||||
chmod +x ./start.sh
|
||||
make dev
|
||||
```
|
||||
|
||||
An electron app should start, frontend is also accessible at [http://localhost:5173](http://localhost:5173).
|
||||
|
||||
14
flowsint-core/README.md
Normal file
14
flowsint-core/README.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# flowsint-core
|
||||
The repository containing the core components for flowsint.
|
||||
|
||||
It contains:
|
||||
- Celery tasks
|
||||
- Authentication
|
||||
- NEO4J database connectors
|
||||
- POSTGRESQL database connectors
|
||||
- Transform base class
|
||||
- Transform orchestrator
|
||||
- Transform registry
|
||||
- Encrypted vault
|
||||
|
||||
> ⚠️ 🚧 Work in progress !.
|
||||
@@ -1,4 +1,4 @@
|
||||
# flowsint-transforms
|
||||
The repository containing open-source transforms for flowsint.
|
||||
|
||||
> ⚠️ 🚧 Work in progress ! No ready yet.
|
||||
> ⚠️ 🚧 Work in progress !.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
The types used in the flowsint transforms and core for flowsint.
|
||||
|
||||
> ⚠️ 🚧 Work in progress ! No ready yet.
|
||||
> ⚠️ 🚧 Work in progress !.
|
||||
|
||||
Reference in New Issue
Block a user