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

updating readme #294

Merged
merged 1 commit into from
Jun 21, 2024
Merged

updating readme #294

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,26 @@ Then input:
```
And select the Poetry Python Interpreter.

### Step 2: Configure environment variables

### Step 2: Initialize Docker Containers
cp .env.example .env

Fill out the variables with your own keys and settings

GIT_TOKEN=<your-github-token>

VERBOSE_LOGGING=true

The langchain variables only work if you have access to Langsmith!
Turn LANGCHAIN_TRACING_V2 to false if not

```
LANGCHAIN_PROJECT
LANGCHAIN_TRACING_V2
LANGCHAIN_API_KEY
```

### Step 3: Initialize Docker Containers
There are two ways you can run the containers:

If you want only the DB running:
Expand All @@ -72,6 +90,8 @@ Then run the server:

Run the frontend

reminder: run from the frontend/ folder

```
poetry run streamlit run chat.py
```
Expand All @@ -83,7 +103,7 @@ docker compose -f docker-compose.full.yml up

The visit localhost:8501 to use the frontend to chat and build your codebase.

### Step 3: Configure and Migrate Database
### Step 4: Configure and Migrate Database

In a new terminal, copy the .env file template:

Expand All @@ -110,7 +130,7 @@ prisma migrate dev --name init

This initializes your database with the required schema.

### Step 4: Generate Prisma Client
### Step 5: Generate Prisma Client

After migrating your database, generate the Prisma client to interact with your database in your application:

Expand All @@ -120,7 +140,7 @@ prisma generate

This command generates or updates the Prisma client, ensuring your application can communicate effectively with the database.

### Step 5: Populate the Database
### Step 6: Populate the Database

Ensure your database is populated with initial data by adjusting the database URL for the specific port and running the population script:

Expand All @@ -130,7 +150,7 @@ Ensure your database is populated with initial data by adjusting the database UR

This populates your database with the initial data set required for your application.

### Step 6: Launch the Application
### Step 7: Launch the Application

Set your environment to local and start the server:

Expand All @@ -140,7 +160,7 @@ Set your environment to local and start the server:

This starts the application's server, making it available for development use.

### Step 7: Access the Documentation
### Step 8: Access the Documentation

Access the running application's interactive documentation at:

Expand Down
Loading