Local development
To run Storyden locally via the repository, it's pretty easy! You can use this approach for testing, experimenting and contributing.
For full development and contribution documentation, please visit the GitHub repository.
Prerequisites
To run Storyden locally, you need to have the following installed:
- Go - the API is written in Go!
- Node.js - the frontend is built with Next.js
- Yarn - the package manager for the frontend
If anything is missing from this list, please hit edit this page or open an issue!
Go
First, clone the repository:
From inside the Storyden directory, you can then run the API service:
This will start the API server with default configuration. You'll get:
./data/data.dbSQLite database./data/assetsto store assets (avatars, images, files, etc.)- A local server running at
http://localhost:8000 - OpenAPI documentation at
http://localhost:8000/api/docs - CORS and cookie rules configured to support localhost
You can also run the frontend service:
Please note that currently, Storyden's web frontend does not support Next.js
--turbo due to some minor issues with Panda CSS.
The frontend will be available at http://localhost:3000 and will by default automatically connect to the API at http://localhost:8000.