https://github.com/zaidmukaddam/openlord.ai
https://github.com/zaidmukaddam/openlord.ai
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zaidmukaddam/openlord.ai
- Owner: zaidmukaddam
- License: mit
- Created: 2024-08-02T17:11:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-03T07:15:16.000Z (about 1 year ago)
- Last Synced: 2025-04-30T20:15:35.953Z (6 months ago)
- Language: TypeScript
- Homepage: https://openlord-ai.vercel.app
- Size: 543 KB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenLord
OpenLord is a simple open-source chatbot built with cutting-edge AI models and technologies. It leverages the power of the Vercel AI SDK to provide an intelligent and responsive chat experience.
## Technologies Used
- [Vercel AI SDK](https://sdk.vercel.ai/docs/)
- [Next.js](https://nextjs.org/)
- [shadcn/ui](https://ui.shadcn.com/)
## Getting Started
### Prerequisites
- Node.js
- npm
### Installation
1. Clone the repository:
```bash
git clone https://github.com/zaidmukaddam/openlord.git
cd openlord
```
2. Install the dependencies:
```bash
npm install
```
3. Create a `.env.local` file in the project root and add your API keys:
```env
cp .env.example .env.local
```
### Running the Development Server
To start the development server, run:
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Configuration
To change the models, you can modify the `model` configurations in the `app/api/chat/route.ts`, `@lib/types.ts` and `@components/chat/SettingsPanel.tsx` files.
## Deployment
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme).
Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Remember to add the environment variables as specified in your [`.env.local`](.env.local) file to your deployment settings.
## License
This project is licensed under the MIT License. See the [`LICENSE`](LICENSE") file for details.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## Acknowledgements
- Inspired by the [Vercel AI SDK](https://sdk.vercel.ai/docs).
## Contact
For any inquiries, please contact [Zaid Mukaddam](zaidmukaddam.com).