Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: restructure readme and add demo video #9

Merged
merged 1 commit into from
Jan 26, 2024
Merged

docs: restructure readme and add demo video #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ A simple way to initiate self-hosted TaskingAI community edition is through [Doc
- Git installed for cloning the repository.
- Python environment (above Python 3.8) for running the client SDK.

### Step-by-Step Guide
### Installation

First, clone the TaskingAI (community edition) repository from GitHub.

Expand All @@ -108,6 +108,16 @@ docker-compose -p taskingai up -d
Once the service is up, access the TaskingAI console through your browser with the URL http://localhost:8080.
The default username and password are `admin` and `TaskingAI321`.

### TaskingAI UI Console

[![TaskingAI Console Demo](https://img.youtube.com/vi/4A5uQoawETU/maxresdefault.jpg)](https://youtu.be/4A5uQoawETU)
***<p style="text-align: center; font-size: small; ">Click the image above for TaskingAI Console Demo Video</p>***



### TaskingAI Client SDK


Once the console is up, you can programmatically interact with the TaskingAI server using the TaskingAI client SDK.

Ensure you have Python 3.8 or above installed, and set up a virtual environment (optional but recommended).
Expand Down