Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vgulerianb/ottomon
Elevate your data apps with seamless, production-ready chat integration. Effortlessly ingest, personalize, and deploy using just a single line of code.
https://github.com/vgulerianb/ottomon
ai chatbot genai langchain llms ml nextjs
Last synced: about 2 months ago
JSON representation
Elevate your data apps with seamless, production-ready chat integration. Effortlessly ingest, personalize, and deploy using just a single line of code.
- Host: GitHub
- URL: https://github.com/vgulerianb/ottomon
- Owner: vgulerianb
- License: mit
- Created: 2023-08-17T15:32:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-14T16:42:32.000Z (over 1 year ago)
- Last Synced: 2024-11-01T21:36:58.735Z (3 months ago)
- Topics: ai, chatbot, genai, langchain, llms, ml, nextjs
- Language: TypeScript
- Homepage: https://ottomon.in
- Size: 74.9 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ottomon: Chat with code, videos, and docs
Ottomon is a powerful GenAI platform that empowers you to effortlessly transform any website, YouTube channel, or GitHub repository into a dynamic chatbot. Whether you're looking to enhance user engagement, streamline support, or simply explore new possibilities, Ottomon has you covered.
## Getting Started
To get started with Ottomon, follow these simple steps:
1. **Clone the Repository**: Begin by cloning the Ottomon repository to your local environment.
```shell
git clone https://github.com/vgulerianb/ottomon.git
```
2. **Configuration**: Create a `.env` file to configure your Ottomon instance. The file should include the following variables:
- `OPENAI_API_KEY`: Your API key for OpenAI.
- `NEXT_PUBLIC_SUPABASE_URL`: The URL for your Supabase instance (create a new project on Supabase for this purpose).
- `SUPABASE_SERVICE_ROLE_KEY`: The service role key for your Supabase instance (create a new project on Supabase for this purpose).
- `JWT_SECRET`: The secret key for signing JWT tokens.
- `SQL_CONNECTION_STRING`: The connection string for your Supabase database (create a new project on Supabase for this).
3. **Initialize the Database**: Run the following command to initialize the database and set up the necessary tables and data in your Supabase instance.
```shell
npx prisma db push
```
4. **Running Ottomon**:
- Using Docker:
- Build the Docker image:
```shell
docker build -t ottomon .
```
- Run the Docker container:
```shell
docker run -p 3000:3000 ottomon
```
- Starting Locally:
- Install dependencies:
```shell
yarn install
```
- Build the application:
```shell
yarn build
```
- Start the Ottomon web application:
```shell
yarn start
```
## Contributing
We welcome contributions to Ottomon! If you'd like to contribute, follow these steps:
1. **Fork the Repository**: Start by forking the Ottomon repository to your GitHub account.
2. **Create a New Branch**: Create a new branch for your feature or bug fix (e.g., `feature/my-new-feature`).
3. **Make Your Changes**: Implement your changes within the branch.
4. **Commit Your Changes**: Commit your changes with a descriptive message (e.g., 'Add some feature').
5. **Push to the Branch**: Push your changes to your branch on GitHub.
6. **Create a Pull Request**: Create a new Pull Request to propose your changes for review and inclusion in the Ottomon project.
Ottomon is an exciting GenAI platform, and your contributions can help make it even better!
---
Feel free to adapt and modify this README as needed for your Ottomon project.