Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
siegblink committed Mar 1, 2024
1 parent 9fd3d9c commit 7d82418
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 7 deletions.
49 changes: 42 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,45 @@

## How to use

- Clone this project's repository
- Install the dependencies by `npm install`
- Create an account at [replicate](https://replicate.com/)
- Get your API token from your replicate account
- Replace the Replicate API token found at `.env.local`
- Run the project by `npm run dev`
- Go to your browser at `localhost:3000`
### 1. Clone this project's repository

In your Terminal app

- Type `git clone git@github.com:siegblink/interior-designer-ai.git`
- Or type `git clone https://github.com/siegblink/interior-designer-ai.git`

### 2. Install the project dependencies

Go to the project's directory

- Type `cd interior-designer-ai`
- Then, `npm install`

### 3. Create an account at [replicate](https://replicate.com/)

![create-account-in-replicate](public/create-account-in-replicate.png)

### 4. Go to the _API tokens_ page within your replicate account

![go-to-api-tokens](public/go-to-api-tokens.png)

### 5. Create your API token and copy it

![create-api-token](public/create-api-token.png)

### 6. Rename the `.env.example` file to `.env.local`

### 7. In `.env.local`, replace the placeholder _your_api_token_ with your API token

```
# Replace 'your-api-token' with your own API token from replicate
REPLICATE_API_TOKEN=your_api_token
```

### 8. Run the project

Back in your Terminal in the project directory, type `npm run dev`

### 9. See the running application in your browser at `localhost:3000`

![see-running-app](public/see-running-app.png)
Binary file added public/create-account-in-replicate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/create-api-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/go-to-api-tokens.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/see-running-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 7d82418

@pociroda1p4
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it display error whole running on localhost of : const response = Unhandled Runtime Error
SyntaxError: Failed to execute 'json' on 'Response': Unexpected end of JSON input!
Image

any solution to this

Please sign in to comment.