/aitys_battle

generate traditional kazakh aitys with AI (not maintained)

Primary LanguageJavaScriptMIT LicenseMIT

Aitys Battle

MIT License

Aitys Battle is a project that generates traditional Kazakh debates called "aitys" between historical figures of Kazakhstan using the GPT API. This project aims to showcase the rich cultural heritage of Kazakhstan and provide an interactive way for users to explore the art of aitys.

Features

  • Aitys Generation: Aitys Battle generates unique aitys battles between historical figures of Kazakhstan. Users can witness engaging debates and learn more about the history and culture of Kazakhstan.

  • Interactive Interface: The project provides a user-friendly interface that allows users to easily navigate and explore aitys battles. Users can also input their own prompts to generate personalized aitys battles.

  • Data Persistence: Aitys Battle saves user preferences and generated battles, allowing users to easily revisit or share their favorite battles with others.

Installation

To install and set up the Aitys Battle project on your local machine, follow these steps:

  1. Clone the repository to your local machine:
git clone https://github.com/your-username/aitys-battle.git
  1. Navigate to the project directory:
cd aitys-battle
  1. Install the project dependencies using npm:
npm install

  1. Configure the necessary environment variables. Refer to the .env.sample file for the required variables.

  2. Start the server:

npm start
  1. Navigate to http://localhost:3000 in your web browser to access Aitys Battle.

Usage

To use Aitys Battle, follow these steps:

  1. Open your web browser and access the Aitys Battle URL.

  2. Generate a new aitys battle by clicking on the "Generate Battle" button.

  3. Explore the battle and its contents. You can read the dialogues between historical figures and learn more about the Kazakh culture.

  4. If desired, input your own prompt in the designated area and click on "Customize Battle" to generate a personalized aitys battle.

  5. Save any interesting battles for future reference or share them with others.

Contributing

We welcome contributions from the community to enhance Aitys Battle. If you wish to contribute, follow these steps:

  1. Fork the project repository.

  2. Create a new branch for your features or bug fixes:

git checkout -b feature/new-feature
git checkout -b fix/issue
  1. Make your changes and commit them with descriptive messages:
git commit -m "Add new feature" (or "Fix issue #123")
  1. Push your changes to your forked repository:
git push origin feature/new-feature (or fix/issue)

  1. Open a pull request from your forked repository to the main project repository.

  2. Wait for the maintainers' review and address any feedback.

  3. Once approved, your changes will be merged into the main project.

If you encounter any issues or have suggestions for improvements, please create a new issue on the project repository.

License

The project is distributed under the MIT License. You are free to use, modify, and distribute the project as per the terms of the license

This README file was written by using Readme GPT