Skip to content

Commit 665ab86

Browse files
authored
Merge pull request #122 from MohamedAliRashad/main
Slightly better README.md
2 parents ad5f8a5 + 74209da commit 665ab86

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ Open Assistant is a project meant to give everyone access to a great chat based
44

55
We believe that by doing this we will create a revolution in innovation in language. In the same way that stable-diffusion helped the world make art and images in new ways we hope Open Assistant can help improve the world by improving language itself.
66

7+
## Do you want to try ?
8+
9+
If you are interested in taking a look at the current state of the project, You can set up an entire stack needed to run **Open-Assistant**, including the
10+
website, backend, and associated dependent services.
11+
12+
To start the demo, Run this in the root directory of the repository:
13+
14+
```sh
15+
docker compose up --build
16+
```
17+
18+
Then, navigate to `http://localhost:3000` (It may take some time to boot up) and interact with the website.
19+
20+
**Note:** When logging in, navigate to `http://localhost:1080` to get the magic email login link.
21+
722
## The Plan
823

924
We want to get to an initial MVP as fast as possible, by following the 3-steps outlined in the InstructGPT paper.
@@ -95,20 +110,6 @@ We are using Python 3.10 for the backend.
95110

96111
Check out the [High-Level Protocol Architecture](https://www.notion.so/High-Level-Protocol-Architecture-6f1fd3551da74213b560ead369f132dc)
97112

98-
## End to End Demo
99-
100-
If you are interested in just taking a look at the project.
101-
You can set up an entire stack needed to run Open Assistant, including the
102-
website, backend, and associated dependent services.
103-
104-
To start the demo, run this, in root directory:
105-
106-
```sh
107-
docker compose up --build
108-
```
109-
110-
Then, navigate to `http://localhost:3000` and interact with the website.
111-
112113
### Website
113114

114115
The website is built using Next.js and is in the `website` folder.

0 commit comments

Comments
 (0)