Skip to content

Commit

Permalink
UPDATE: updated the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sushidelivery committed Jan 22, 2024
1 parent d5ce2ba commit b7089c3
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,36 +22,36 @@

## Getting Started

## For Users:
### 1. Go to the specified URL:
### For Users:
1. **Go to the specified URL**:

Visit the EPFL server at: http://128.178.91.106:16666/docs

### 2. Follow the instructions:
2. **Follow the instructions**:

Check out our [Wiki](https://github.com/ibois-epfl/TTool-ai/wiki) for more details.


## For Developers:
### For Developers:

### 1. Make sure you have the system dependencies installed.
### 2. Clone the repository:
1. **Make sure you have the system dependencies installed**
2. **Clone the repository**:

```bash
git clone [email protected]:ibois-epfl/TTool-ai.git
```
```bash
git clone [email protected]:ibois-epfl/TTool-ai.git
```

### 3. Run the project:
Navigate to the project's root directory and run the following command:
```bash
cd TTool-ai/
```
Run Docker Compose to build the project in the foreground:
```bash
docker compose up
```
3. **Run the project**:
Navigate to the project's root directory and run the following command:
```bash
cd TTool-ai/
```
Run Docker Compose to build the project in the foreground:
```bash
docker compose up
```
### 4. Access the Service:
4. **Access the Service**:
Once everything is up and running, you can access the FastAPI interface at:
- If built on localhost: http://localhost:16666/docs
- If built on a remote server: Use the appropriate IP address.
Expand Down

0 comments on commit b7089c3

Please sign in to comment.