Skip to content

Commit

Permalink
docs: add updated docs and contrib list
Browse files Browse the repository at this point in the history
  • Loading branch information
Nyumat committed Oct 31, 2024
1 parent 760744a commit d3a8906
Showing 1 changed file with 40 additions and 10 deletions.
50 changes: 40 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## BeavsAI
## Beavs AI

BeavsAI is an application that provides an AI Chatbot that is knowledgeable about OSU's courses. It allows OSU students to interact with an AI agent that can answer course-specific questions.
Beavs AI is an application that provides an AI Chatbot that is knowledgeable about OSU's courses. It allows OSU students to interact with an AI agent that can answer course-specific questions.

## Project Prerequisites

Expand All @@ -27,25 +27,55 @@ BeavsAI is an application that provides an AI Chatbot that is knowledgeable abou
> [!NOTE]
> You may come across an peer dependency error when running this command, try `npm install --legacy-peer-deps`
4. Create an AUTH_SECRET environment variable
4. Create an `.env.local` file in the root directory of the project and add the following environment variables:

```bash
npx auth secret
DATABASE_URL="postgresql://prisma_user:prisma_password@localhost:5432/prisma_db"
AUTH_GOOGLE_ID=
AUTH_GOOGLE_SECRET=
```

5. Add this DATABASE_URL variable to .env.local
5. Message [@nyumat](https://discord.com/users/700444827287945316) on Discord to get the OAuth credentials for the application.

```
DATABASE_URL="postgresql://prisma_user:prisma_password@localhost:5432/prisma_db"
> [!WARNING]
> Do not share these credentials with anyone else. You will not be able to run the application without them.
6. Create an AUTH_SECRET environment variable

```bash
npx auth secret
```

6. Open a new terminal window and start up our Postgres database
7. Start a local PostgreSQL database using Docker

```bash
docker compose up
docker compose up -d
```

7. Run the Next.js App
8. Run the Next.js App
```bash
npm run dev
```

<div align="start">
<h2>Contributors</h2>
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/Nyumat">
<img src="https://images.weserv.nl/?url=github.com/Nyumat.png&fit=cover&mask=circle" width="80"><br>
Tom Nyuma
</a>
</td>
<!-- TEMPLATE BELOW (uncomment to include) -->
<!-- <td align="center">
<a href="https://github.com/[username]">
<img src="https://images.weserv.nl/?url=github.com/[username].png&fit=cover&mask=circle" width="80"><br>
[Full Name]
</a>
</td> -->
</tr>
</tbody>
</table>
</div>

0 comments on commit d3a8906

Please sign in to comment.