Skip to content

hbdermott/ai-tale

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

ai-tale is a story platform that uses openai to generate stories. It allows users to select options to insert that are also suggested by the AI. This kind of restriction allows for some wacky stories. There will eventually be suppor to post and read other peoples wacky generated stories.

(back to top)

Built With

(back to top)

Getting Started

Follow these steps to run the project

Prerequisites

  • npm
    npm install npm@latest -g

Installation

The current implementation uses secret openai keys. Testing features will require you to setup your own openai account and put your keys in a .env file

  1. Clone the repo
    git clone https://github.com/hbdermott/ai-tale.git
  2. Install NPM packages
    npm install

(back to top)

Usage

  1. To run in dev mode npm dev
  2. Or build and run npm build && npm start

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Hunter Dermott - @your_twitter - Email

Links: ai-tale - hbdermott/ai-tale

(back to top)

About

An OpenAI Madlib style story generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published