-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
64bb66f
commit 3d6bd83
Showing
1 changed file
with
40 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,117 +1,55 @@ | ||
| # Next.js App Template | ||
| # Paradox AI | ||
|
|
||
| This is a Next.js app template configured with Prettier, ESLint, and Tailwind CSS. The repository also contains branches for additional setups like Jest and BiomeJS as the linter. | ||
| Paradox AI is a **Next.js application** designed to provide instant answers from videos, documents, and websites using **Large Language Models (LLMs)**. This tool leverages the power of AI to make it easy to extract and retrieve accurate, context-based information from various media sources. | ||
|
|
||
| ## Getting Started | ||
| ## Features | ||
|
|
||
| First, clone the repository: | ||
| - **Video Question Answering**: Upload videos and obtain answers by searching through their transcripts. | ||
| - **Document-Based Q&A**: Parse and analyze document content (PDF, Word, etc.) for specific information retrieval. | ||
| - **Website Content Analysis**: Enter a URL to get answers based on website content. | ||
| - **LLM-Powered**: Utilizes advanced language models for precise and relevant answers. | ||
| - **User-Friendly Interface**: Built with Next.js to ensure smooth, interactive user experiences. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/haider-patanwala/nextjs-app-template.git | ||
| cd nextjs-app-template | ||
| ``` | ||
| ## Tech Stack | ||
|
|
||
| or create new repository from template by clicking on the link below 👇 | ||
| - **Next.js**: Frontend framework enabling server-side rendering and optimized performance. | ||
| - **LLMs (Language Models)**: Drive the core question-answering capabilities. | ||
|
|
||
| [nextjs-template](https://github.com/new?template_name=nextjs-template&template_owner=haider-patanwala "https://github.com/new?template_name=nextjs-template&template_owner=haider-patanwala") | ||
| ## Installation | ||
|
|
||
| Install the dependencies: | ||
| 1. Clone the repository: | ||
| ```bash | ||
| git clone https://github.com/yourusername/paradox-ai.git | ||
| ``` | ||
| 2. Navigate to the project folder: | ||
| ```bash | ||
| cd paradox-ai | ||
| ``` | ||
| 3. Install dependencies: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
| 4. Start the development server: | ||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ``` | ||
| npm install | ||
| # or | ||
| yarn install | ||
| ``` | ||
| ## Usage | ||
|
|
||
| Run the development server: | ||
| 1. **Video Q&A**: Upload a video to extract answers from its content. | ||
| 2. **Document Q&A**: Drag and drop a document to obtain answers based on the file's content. | ||
| 3. **Website Q&A**: Enter a URL, and the tool will crawl the page to generate responses. | ||
|
|
||
| ``` | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| ``` | ||
| ## Future Enhancements | ||
|
|
||
| ## Main Branch Setup | ||
| - **Multilingual Support**: Expanding LLM support for multiple languages. | ||
| - **Extended Media Types**: Adding more document and video formats. | ||
| - **Model Selection**: Allow users to choose from a range of language models. | ||
|
|
||
| ### Prettier | ||
|
|
||
| Prettier is configured to format your code. You can run it with: | ||
|
|
||
| ### ESLint | ||
|
|
||
| ESLint is set up for linting your JavaScript/TypeScript code. You can run the linter with: | ||
|
|
||
| ### Tailwind CSS | ||
|
|
||
| Tailwind CSS is configured for styling. You can start using it by adding classes to your components. | ||
|
|
||
| ## Additional Branches | ||
|
|
||
| ### Jest Setup | ||
|
|
||
| Switch to the `jest-setup` branch to get a setup with Jest for testing: | ||
|
|
||
| ``` | ||
| git checkout jest-setup | ||
| ``` | ||
|
|
||
| Install the dependencies: | ||
|
|
||
| Run the tests: | ||
|
|
||
| ``` | ||
| npm run test | ||
| # or | ||
| yarn test | ||
| ``` | ||
|
|
||
| ### Playwright Setup | ||
|
|
||
| Switch to the `playwright-setup` branch to get a setup with Playwright for end-to-end testing: | ||
|
|
||
| ``` | ||
| git checkout playwright-setup | ||
| ``` | ||
|
|
||
| Run the tests: | ||
|
|
||
| ``` | ||
| # Build and run the project | ||
| npm run build | ||
| npm run start | ||
| # Open new terminal | ||
| npx playwright test | ||
| ``` | ||
|
|
||
| ### BiomeJS as Linter | ||
|
|
||
| Switch to the `biomejs-setup` branch to use BiomeJS as the linter: | ||
|
|
||
| ``` | ||
| git checkout linter-biomejs | ||
| ``` | ||
|
|
||
| Install the dependencies: | ||
|
|
||
| Run the linter: | ||
|
|
||
| ``` | ||
| npx @biomejs/biome lint . | ||
| ``` | ||
|
|
||
| ## Learn More | ||
|
|
||
| To learn more about Next.js, Prettier, ESLint, Tailwind CSS, Jest, and BiomeJS, take a look at the following resources: | ||
| ## Contributing | ||
|
|
||
| - [Next.js Documentation]() | ||
| - [Prettier Documentation]() | ||
| - [ESLint Documentation]() | ||
| - [Tailwind CSS Documentation](https://tailwindcss.com/docs) | ||
| - [Jest Documentation]() | ||
| - [BiomeJS Documentation]() | ||
| Contributions are welcome! Feel free to open issues, fork the repo, and submit pull requests. | ||
|
|
||
| ## Contributing | ||
| ## License | ||
|
|
||
| If you have suggestions or improvements, feel free to open an issue or submit a pull request. | ||
| This project is licensed under the MIT License. |