Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/preston176/nexusai
Nexus AI is an innovative platform designed to empower users by securely storing their documents and providing intelligent, document-based responses
https://github.com/preston176/nexusai
clerk-authentication customhooks firebase langchain nextjs15 paystack pinecone
Last synced: 6 days ago
JSON representation
Nexus AI is an innovative platform designed to empower users by securely storing their documents and providing intelligent, document-based responses
- Host: GitHub
- URL: https://github.com/preston176/nexusai
- Owner: preston176
- Created: 2024-12-15T15:53:27.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-02-11T06:51:24.000Z (10 days ago)
- Last Synced: 2025-02-11T07:32:04.705Z (10 days ago)
- Topics: clerk-authentication, customhooks, firebase, langchain, nextjs15, paystack, pinecone
- Language: TypeScript
- Homepage: https://nexusai-pdf.vercel.app
- Size: 871 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Nexus AI
Store and Chat with Your Documents anywhere anytime
Key Features •
How To Use •
Live Link •
Disclaimer •
Related •
License
## Key Features
**Chat with your Docs** - Get to interact with your documents using GPT-4o
* **Secure** - Multi-factor Authentication and Secure Document Storage using Clerk and Firebase respectively.
* **Pricing** - The Free / Pro plan is available to allow you access all features.
* **Real Time Subscription** - Paystack Integration, Pay for the Pro Plan using M-Pesa, Visa, Mastercard
## How To Use
To clone and run this web app, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/preston176/nexusAI
# Go into the repository
$ cd nexusAI
# Install dependencies
$ npm install
# Run the app
$ npm run dev
# Open browser http://localhost:3000
```
### .env Configuration Guide
1. Create A `.env` file and add the following:
Environment Variables
```bash
# Clerk API Keys
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_xxxxxxxxxx
CLERK_SECRET_KEY=sk_test_xxxxxxxxxx
# Pinecone API Key
NEXT_PUBLIC_PINECONE_API_KEY=pcsk_xxxxxxxxxxxx
# Gemini API Key
NEXT_PUBLIC_GEMINI_API_KEY=AIzxxxxxxxxxxxx
# OpenAI API Key
OPENAI_API_KEY=sk-proj-xxxxxxxxxx
# Paystack API Keys
NEXT_PUBLIC_PAYSTECK_PUBLISHABLE_KEY=pk_test_xxxxxxxxxxxxx
PAYSTACK_API_KEY=sk_test_xxxxxxxxxxxxxxx
NEXT_PUBLIC_PAYSTACK_PUBLIC_KEY=pk_test_xxxxxxxxxxxxxxx
PAYSTACK_WEBHOOK_SECRET=abc
# Firebase
FIREBASE_STORAGE_BUCKET=xxxxxx.firebasestorage.app
FIREBASE_SERVICE_ACCOUNT_JSON=
you can do this by running cat service_key.json | base64 after downloading the service_key.json file and placing it in the root of the project
# Azure OpenAI API Configuration
AZURE_OPENAI_API_INSTANCE_NAME=nexusaxxxxx
AZURE_OPENAI_API_KEY=5KdeOKxxxxxxx
AZURE_OPENAI_API_VERSION=2024-02-01
AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME=text-embedding-ada-002
```
## Live Preview
- https://nexusai-pdf.vercel.app/
## Disclaimer
- Copyright Compliance: By using [NexusAI](https://nexusai-pdf.vercel.app/), you agree to comply with Clerk's terms of service and respect copyright laws.
## Support
## License
MIT
---
> [prestonmayieka.tech](https://www.prestonmayieka.tech) ·
> GitHub [@preston176](https://github.com/preston176) ·
> Twitter [@preston_mayieka](https://twitter.com/preston_mayieka)