Skip to content

Commit f40863c

Browse files
authored
Basic Setup Instructions (#1486)
## Description <!-- Please provide a brief description of the changes made in this pull request. Include any relevant context or reasoning for the changes. --> Update ReadMe with some basic setup instructions. These will need to be fully fleshed out and expanded once we have a better picture of how the frontend integrates with the backend in local dev. ## Related Issue and Pull requests <!-- Link to any related issues using the format #<issue-number> --> ## Type of Change <!-- Please delete options that are not relevant --> - [x] Documentation update ## Checklist <!-- Please ensure the following are completed before submitting the PR --> - [ ] I have tested this does not break current pipelines / runs functionality - [ ] I have tested the changes on staging ## Screenshots (if applicable) <!-- Include any screenshots that might help explain the changes or provide visual context --> ## Test Instructions <!-- Detail steps and prerequisites for testing the changes in this PR --> ## Additional Comments <!-- Add any additional context or information that reviewers might need to know regarding this PR -->
1 parent 84d2b96 commit f40863c

File tree

1 file changed

+53
-14
lines changed

1 file changed

+53
-14
lines changed

README.md

Lines changed: 53 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
# Tangle app
1+
# Tangle app (Frontend)
22

33
Tangle is a web app that allows the users to build and run Machine Learning pipelines using drag and drop without having to set up development environment.
44

55
[![image](https://github.com/user-attachments/assets/0ce7ccc0-dad7-4f6a-8677-f2adcd83f558)](https://tangleml-tangle.hf.space/#/quick-start)
66

7-
<!--
8-
## Video
7+
This is the frontend repo. It contains the entire user interface portion of the app. It is built primarily on Typescript + React + Tailwind CSS, and powered by NodeJS + Vite.
98

10-
Please take a look at the short video demonstrating the first version of the visual pipeline editor.
11-
12-
[Cloud Pipelines Editor - Build machine learning pipelines without writing code](https://www.youtube.com/watch?v=7g22nupCDes)
13-
-->
9+
> Go to the [backend repo](https://github.com/TangleML/tangle).
1410
1511
## Demo
1612

@@ -20,21 +16,64 @@ The experimental new version of the Tangle app is now available at <https://tang
2016

2117
Please check it out and report any bugs you find using [GitHub Issues](https://github.com/TangleML/tangle/issues).
2218

23-
The app is under active development, so expect some breakages as I work on the app and do not rely on the app for production.
19+
The app is under active development and supported by Shopify Engineers.
20+
21+
## Installation
22+
23+
**tangle-ui** can be operated and developed independently of the backend.
24+
25+
### Standalone Web App - Instructions
26+
27+
1. Install [Node Package Manager](https://www.npmjs.com/) (`npm`) & `node`
28+
2. Fork the `tangle-ui` repo - we recommend colocating the repo with the backend
29+
3. Navigate to the forked repo and install dependencies with `npm i`
30+
4. You are now ready to go! Run the app with `npm run start` 🚀
31+
32+
You can now run tangle-ui as a standalone web app! Pipelines and data will be stored in browser storage. If you want to make use of backend features, such as executing runs you will need to connect to a backend.
33+
34+
### Integrated Web App - Instructions
35+
36+
1. Complete the steps above
37+
2. Complete the installation steps for the backend as specified in the [backend repo](https://github.com/TangleML/tangle)
38+
3. Create a `.env` file at the root of `tangle-ui`
39+
4. Add an env variable `VITE_BACKEND_API_URL` with the url where your backend is hosted (most likely `http://127.0.0.1:8000`)
40+
5. Run the backend & restart the frontend app
41+
42+
<!-- todo: CORS -->
43+
44+
You should now be running Tangle in its entirety and can enjoy its full suite of features!
45+
46+
If you find you are blocked by CORS, you will, for now, need to use the manual steps below.
47+
48+
#### If all Else Fails
49+
50+
1. Complete the installation steps for the backend as specified in the [backend repo](https://github.com/TangleML/tangle)
51+
2. Co-locate your local `tangle-ui` repo inside your local `tangle` repo
52+
3. Run `npm run build` inside `tangle-ui`
53+
4. Start the backend using the provided instructions in the `tangle` repo
54+
55+
If you complete these steps the app will launch on `127.0.0.1:8000` with the latest build you've created on the frontend.
2456

25-
### App features:
57+
## App features:
2658

27-
- Build pipeline using drag and drop
28-
- Edit component arguments
29-
- Submit the pipeline for execution. (Follow the [backend installation instructions](https://github.com/Cloud-Pipelines/backend?tab=readme-ov-file#installation).)
59+
- Build and edit pipelines using drag and drop visual editor
60+
- Configure component arguments
61+
- Submit the pipeline for execution. (Follow the [backend installation instructions](https://github.com/TangleML/tangle?tab=readme-ov-file#installation).)
3062
- The ComponentSpec/`component.yaml` format used by Cloud Pipelines is fully compatible with the Google Cloud Vertex AI Pipelines and Kubeflow Pipelines v1. You can find many components here: [Ark-kun/pipeline_components](https://github.com/Ark-kun/pipeline_components/)
3163
- Preloaded component library
3264
- User component library (add private components)
65+
- Remote component library
66+
- GitHub-based libraries
3367
- Component search
3468
- Import and export pipelines
69+
- Create subgraphs and nested pipelines
70+
- In-app component editor
71+
- Disable cache
72+
- Cancel executions
73+
- Clone pipelines and review ongoing executions (logs, artifacts, run status)
3574

36-
There are many features that I want to add, but I want to prioritize them based on your feedback.
75+
Feel free to provide feedback, flag and issue or make a suggestion: [issues](https://github.com/TangleML/tangle-ui/issues).
3776

38-
### Credits:
77+
## Credits:
3978

4079
This app is based on the [Pipeline Editor](https://cloud-pipelines.net/pipeline-editor) app created by [Alexey Volkov](https://github.com/Ark-kun) as part of the [Cloud Pipelines](https://github.com/Cloud-Pipelines) project.

0 commit comments

Comments
 (0)