Git Product home page Git Product logo

storycraft's Introduction

项目简介

一个用于与生成式AI交互创作故事的应用。

功能:

  • 简陋的界面和用户校验、兼容移动端
  • 新建故事、设置故事背景
  • 在故事下新建角色、设置角色信息、设置角色头像
  • 新建故事下的会话
  • 与模型轮流推进故事
  • 编辑、删除任何模型已输出的故事情节(更简单地控制模型接下来的输出)

示例: 示例图片

安装和运行指南

前端部署

本项目的前端使用Vue.js框架开发,以下是启动和部署前端代码的步骤:

  1. 进入前端项目目录:
    cd frontend
  2. 安装依赖:
    npm install
  3. 运行开发服务器(用于开发测试):
    npm run serve
  4. 生产环境打包:
    npm run build
  5. 根据 env.example 文件创建 .env 文件,进行配置

后端部署

后端支持Docker容器化部署,以下是使用Docker部署后端的步骤:

  1. 进入后端项目目录:
    cd backend
  2. 使用Docker Compose启动服务:
    docker-compose up -d
  3. 在自动生成的 .env 文件中进行配置(数据库相关的信息会被自动配置)

如果选择不使用Docker进行部署:

  1. 进入后端项目目录:
    cd backend
  2. 安装依赖:
    composer install
  3. 根据 env.example 文件创建 .env 文件,进行相关配置
  4. 运行yii migration:
    yii migrate
  5. 选择你喜欢的Web服务器进行配置

备注

  • 默认用户token为 8nD5k1hopW
  • 后端默认使用Gemini 1.5 Pro模型,如需使用其他模型,请重写 backend/components/LLM 并修改 backend/config/LLM 中的相关配置
  • 如果你的云服务器不能访问你需要的模型,可以在 backend/.env 中将FRONTEND_PROXY设置为1
    • 此时,前端会代替后端向模型发送生成请求
    • 这会将你的API Key暴露给前端,请仅在供个人使用时使用此功能

许可证

本项目的前端和后端(自开发部分)代码均采用MIT许可证发布。许可证全文位于项目根目录下的 LICENSE 文件中。

Yii2框架许可证

后端使用了Yii2框架,Yii2框架的许可证文本位于后端代码目录下的 LICENSE 文件中。详情请参阅该文件。

贡献

欢迎开发者为本项目贡献代码。请提交Pull Request或为项目提出Issues。

storycraft's People

Contributors

xtcvfilh avatar

Stargazers

 avatar Avishek Biswas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.