Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Daiyi Yang authored and Daiyi Yang committed Jul 22, 2023
1 parent 4841e9a commit 114d09e
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ The video is muted by default, 🎧 Unmute for audio explanations and improve yo

### Quick Start

Live Demo

[https://app.dsensei.app](https://app.dsensei.app)

Running Locally

```shell
docker run -p 5001:5001 dsenseiapp/dsensei
```
Expand All @@ -20,8 +26,7 @@ Open [http://localhost:5001](http://localhost:5001)

- [What is DSensei](#What-is-DSensei)
- [Setup](#Setup)
- [Usage](#Usage)
- [Known Issues](#Known-Issues)
- [Contact](#Contact)

## What is DSensei

Expand Down Expand Up @@ -64,7 +69,7 @@ docker run -p 5001:5001 dsenseiapp/dsensei

This will pull the latest version of the DSensei-insight image and start the application on port 5001.

### Running Locally
### Running from code

To run the application locally without Docker, you need to have `python3` and `nodejs-18` installed on your system, then follow these steps.

Expand All @@ -73,4 +78,6 @@ To run the application locally without Docker, you need to have `python3` and `n
3. Switch to the `backend` directory and install python dependencies: `python install -r requirements.txt`
4. Finally, run the application by executing the following command in the backend directory `flask run -p 5001`

## Usage
## Contact

Please submit your bug report or feature request directly on github or in our [discord group](https://discord.gg/fRzNUEugRU). We appreciate all your feedback!

0 comments on commit 114d09e

Please sign in to comment.