Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aridanpantoja/harpia-bot

Chatbot developed to assist prospective students of the Federal University of ParΓ‘ (UFPA) with queries related to the PS 2025 admission process.
https://github.com/aridanpantoja/harpia-bot

gemini next nextjs react reactjs tailwindcss vercel-ai-sdk

Last synced: 25 days ago
JSON representation

Chatbot developed to assist prospective students of the Federal University of ParΓ‘ (UFPA) with queries related to the PS 2025 admission process.

Awesome Lists containing this project

README

        

Harpia πŸ¦…


This project is a chatbot developed to assist prospective students of the Federal University of ParΓ‘ (UFPA) with queries related to the PS 2025 admission process.

Tech Stack πŸ’»

[![My Skills](https://skillicons.dev/icons?i=nodejs,react,nextjs,ts,tailwind,redis,vercel,git,github)](https://skillicons.dev)

Project Overview πŸ“‹

### Getting Started

#### 1. Create a `.env.local` file in the root directory and add your environment variables as follows:

```env
GOOGLE_GENERATIVE_AI_API_KEY="your api key here"
UPSTASH_REDIS_REST_URL="your redis url here"
UPSTASH_REDIS_REST_TOKEN="your redis token here"
```

#### 3. Install required dependencies with pnpm

```bash
pnpm install
```

#### 2. Running the development server

```bash
pnpm dev
```

Contribute πŸš€

If you want to contribute, clone this repo, create your work branch and get your hands dirty!

```bash
git clone https://github.com/aridanpantoja/harpia-bot.git
```

```bash
git checkout -b feature/NAME
```

At the end, open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

### Documentations that might help

[πŸ“ How to create a Pull Request](https://www.atlassian.com/br/git/tutorials/making-a-pull-request) |
[πŸ’Ύ Commit pattern](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)

License πŸ“ƒ

This project is under [MIT](./LICENSE) license