Skip to content

Mix and twist your favorite books with the power of AI!πŸ“–

Notifications You must be signed in to change notification settings

AstraBert/books-mixer-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Books-Mixer AI

Mix and Twist Your Favorite Books!πŸ“–

GitHub top language GitHub commit activity Static Badge Static Badge Static Badge
Books-Mixer AI logo

Books-Mixer AI logo

This project was built and shipped thanks to:

React.js logo

React.js


Vercel logo

Vercel

User guide

1. Understand the purpose of Books-Mixer AI

Books-Mixer AI is a web application that lets you mix the plots of two books based on your instructions and on the information it can retrieve about the books from Wikipedia.

2. How it works

Books-Mixer AI works on a very simple chat interface, in addition to which you have four text boxes, where you need to specify:

  • the titles of the two books you want to mix
  • your OpenAI API key
  • your ModelsLab API keys (more on that in the dedicated section)

You can then type your instructions for plot generation directly in the chat space.

3. Get your API keys

To get your API keys:

  • OpenAI: you need to subscribe to OpenAI services and then you can login to your personal dashboard where, under the API keys section, you will be able to get your personal key by clicking on + Create new secret key.
  • ModelsLab: you need to sign up on ModelsLab platform and then, from the dashboard, just go to API settings and click on Create new key.

You just now have to copy them and paste in the dedicated text boxes on the app!πŸš€

Developer guide

Run the app locally

There are two ways you can play with the app locally:

1. Docker image

You can pull the Docker image:

docker pull astrabert/books-mixer-ai:latest

And run it on port 3000:

docker run -p 3000:3000 astrabert/books-mixer-ai:latest

The app will be up and running on http://localhost:3000 in less than 30s.

2. Source code

⚠️: Ensure you have npm and node installed on your local machine!

Clone the GitHub repository:

git clone Https://github.com/AstraBert/books-mixer-ai.git

cd books-mixer-ai

Install necessary packages:

npm install

After that, you should be able to make the application work by running:

npm start

The application should be running on http://localhost:3000 in less than a minute!😊

Contribute

Follow the contribution guidelines you can find in CONTRIBUTING.md

Support the project

If you found this project useful and want it to keep being open source, consider funding it on GitHub sponsors.