https://github.com/ifirmawan/narrate-ai
Narrate AI is a demo application designed to generate stories, blogs, or journal entries based on key points or summaries, showcasing the power of Mistral AI for content creation.
https://github.com/ifirmawan/narrate-ai
mistral-small text-generation
Last synced: 2 months ago
JSON representation
Narrate AI is a demo application designed to generate stories, blogs, or journal entries based on key points or summaries, showcasing the power of Mistral AI for content creation.
- Host: GitHub
- URL: https://github.com/ifirmawan/narrate-ai
- Owner: ifirmawan
- Created: 2024-10-30T14:39:22.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T08:58:30.000Z (6 months ago)
- Last Synced: 2025-01-26T02:52:20.124Z (4 months ago)
- Topics: mistral-small, text-generation
- Language: JavaScript
- Homepage:
- Size: 1.34 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Narrate AI
Narrate AI is a demo application designed to generate stories, blogs, or journal entries based on key points or summaries, showcasing the power of Mistral AI for content creation.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Environment Variables](#environment-variables)
- [Running the App](#running-the-app)
- [Feedback and Contributions](#feedback-and-contributions)
## Features
- Create stories based on summary points.
- Generate polished content quickly using Mistral AI.
- Simple and intuitive UI for easy interaction.
- Integrated Google reCAPTCHA for security.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- **Node.js** (version 18 or above)
- **npm** or **yarn**
## Installation
1. **Clone the repository**
```bash
git clone https://github.com/ifirmawan/narrate-ai.git
cd narrate-ai
```
2. **Install dependencies**
```bash
# Using npm
npm install
# Or, using yarn
yarn install
```
## Environment Variables
To run this project, you’ll need to add the following environment variables in a `.env` file at the root of the project:
```plaintext
MISTRAL_API_KEY=your_mistral_api_key
NEXT_PUBLIC_RECAPTCHA_SITE_KEY=your_recaptcha_site_key
GOOGLE_RECAPTCHA_SECRET_KEY=your_recaptcha_secret_key
```
These keys are necessary for connecting to the Mistral AI API and securing the application with Google reCAPTCHA.
## Running the App
Once you have installed the dependencies and set up the environment variables, you can start the application:
```bash
# Using npm
npm run dev
# Or, using yarn
yarn dev
```
The app should now be running at [http://localhost:3000](http://localhost:3000).
## Feedback and Contributions
We’d love to hear your feedback! If you encounter any issues or have suggestions for improvements, please [create an issue](https://github.com/ifirmawan/narrate-ai/issues) on GitHub.
---
© 2024 Narrate AI. Built by Iwan Firmawan.