Skip to content

eike-heimpel/story-app

Repository files navigation

Story Creation App

cd pocketbase ./pocketbase serve

--> separate terminal window, from inside the root story-app folder

npm run dev

--> localhost:5173 (usually, check npm run dev output)

Introduction

Welcome to the Story Creation App, a tool designed to help you in your creative writing process, whether for short stories, novels, movie scripts, or more. Our platform dynamically caters to your unique writing approach, facilitating as much or as little involvement as you prefer.

At the heart of our application is an advanced Large Language Model (LLM) which serves as a reasoning engine. Here are a few scenarios in which our application can assist you:

  • If you've written the first chapter of your novel and need guidance to drive your story forward.
  • If you have a rough idea for a story and need help fleshing out the details.
  • If you have detailed notes and want the LLM to generate a full text.

Our application is a one-stop tool, featuring an interactive chat with the LLM, data storage, and everything else you need for your creative writing journey.

Tech Stack

Our application is built using the following technologies:

  • SvelteKit: We use SvelteKit to create our UI, taking advantage of its efficient approach to building web applications.
  • PocketBase: We use PocketBase for database management, offering secure, flexible, and real-time data storage and retrieval.

For more details on these technologies, you can visit the PocketBase documentation.

Getting Started

To start working on this project, follow the steps below:

  1. Ensure that you have Node.js installed on your system. You can download it here.
  2. Install SvelteKit by running npm create svelte@latest story-app in your terminal.
  3. Navigate to your new project directory using cd story-app.
  4. Install the necessary dependencies by running npm install.
  5. Start the development server using npm run dev -- --open.
  6. Create a .env file in the root directory and add your open API key like so OPENAI_API_KEY="my-cool-key"
  7. Download the pocketbase client and start a server (currently expected on localhost:8090, the default)
  8. Create an admin user with the email [email protected] and pw: testtesttest. This is used for test auth when saving to the DB

This will open the application in your default web browser. Happy coding!

Notes