Taleweave

Table of Contents

• Taleweave
  • Table of Contents
  • About the project
  • Discord
  • Tech Stack
  • Roadmap
  • Getting Started
    • Prerequisites
    • Installation
  • Contributing
  • License

About the project

Taleweave is an open-source, and easy to use platform for writers and authors alike to share their stories and works of literature freely. On this platform you as an author can create an account, write your stories, and publish them for the world to see and appreciate. Taleweave is by writers, for writers.

Discord

Taleweave has a discord server where you can get help, ask questions, and get involved in the community. Join the discord server today!

Tech Stack

Originally built as a pet project, this platform is built on cutting-edge web technologies like sveltekit for the frontend, prisma + planetscale for the database, lucia for authentication and authorization, and tailwindcss for styling.

• Frontend: SvelteKit
• Database: Prisma + PlanetScale
• Authentication: Lucia

Roadmap

See the Github projects page for a list of features and enhancements that are planned for the future.

Roadmap :link:

Getting Started

To get started developing for this project locally, follow the simple steps outlined below:

Prerequisites

Make sure you have the following installed on your machine:

• Node.js (v18 or later is recommended)
• pnpm

Installation

1. Clone the repo

   git clone https://github.com/joshwcorbett/taleweave.git taleweave
   

2. Install dependencies

   pnpm install
   

3. Create your own .env file and populate it with the following value:

   DATABASE_URL="mysql://<username>:<password>@<host>:<port>/<database>?connection_limit=1"
   

4. Run the project

   pnpm dev
   

Contributing

Any contributions you make are greatly appreciated. Feel free to fork the project and submit a pull request.

License

Distributed under the Apache 2.0 License. See LICENSE for more information.