Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DifuseHQ/Kalmia
A documentation CMS written in go
https://github.com/DifuseHQ/Kalmia
Last synced: 2 months ago
JSON representation
A documentation CMS written in go
- Host: GitHub
- URL: https://github.com/DifuseHQ/Kalmia
- Owner: DifuseHQ
- License: agpl-3.0
- Created: 2024-08-05T20:57:38.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-09-09T06:34:35.000Z (2 months ago)
- Last Synced: 2024-09-09T12:55:14.696Z (2 months ago)
- Language: TypeScript
- Homepage: https://kalmia.difuse.io
- Size: 23.3 MB
- Stars: 320
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - DifuseHQ/Kalmia - A documentation CMS written in go (TypeScript)
README
# Kalmia
> [!WARNING]
> This project is still in development so expect breaking changes!
https://github.com/user-attachments/assets/19d7b3e3-0f8d-49b6-a8e1-b8885ceec467
Kalmia is a Go tool with a web interface for managing RsPress documentation. It supports multiple versions, multiple users, and includes a markdown editor for easy edits. Please visit our [website](https://kalmia.difuse.io) for more information on how to use Kalmia and its features.
## Requirements
- Go >= 1.22
- Node.js (version v20.15.0 or later)
- npm (usually comes with Node.js)
- PostgreSQL >= 15 (If you're not using SQLite)
## Installation
You can download from releases, our website or even clone the repository:
```bash
git clone https://github.com/DifuseHQ/kalmia.git
cd kalmia
```
## Building
Kalmia uses a Makefile to manage build processes. Here are the main commands:
1. Build everything (including dependencies):
```bash
make all
```
2. Install dependencies (including building the web application):
```bash
make deps
```
3. Run tests:
```bash
make test
```
4. Build for specific platforms:
```bash
make build-amd64-linux
make build-arm64-linux
make build-win64
make build-freebsd64
make build-macos-arm64
make build-macos-amd64
```
5. Build for all supported platforms:
```bash
make build
```
6. Clean build artifacts:
```bash
make clean
```
## Usage
After building, you can find the executable in the dist directory. Run it with:
```bash
cd dist && ./kalmia__
```
Replace and with the appropriate values.
Remember there should be a config.json file in the same directory as the executable or you can specify the same with the -config flag.
You can visit the website at http://localhost:2727/admin to start using Kalmia.
## Contributing
We welcome contributions from the community. Please feel free to submit a Pull Request. We primarily use SQLite while developing, to setup a development environment, you can run:
```bash
npm install
npm run start
```
In the web/ directory and then run:
```bash
air .
```
In the root directory in a separate terminal to start the Go server. Make sure you have Air installed.
## License
AGPL-3.0