Skip to content

Open-source publication management that lets you work less and get more done.

License

Notifications You must be signed in to change notification settings

LibArticles/articleman

Repository files navigation

Articleman

built with nix GitHub License

I don't like running things on spreadsheets - they're just not the best option. They work for one person, maybe, but with two people suddenly either email or Google Workspace gets involved and things only go downhill from there.

"Please don't touch the A2:C13 range of cells!" -statements made by the utterly deranged.

Designed to be extraordinarily lightweight (the entire backend stack, excluding the frontend server, is written in Rust, which lacks a garbage collector) and fast (aiming for <250ms round-trip response time on any given request)

Articleman is built in Rust and TypeScript, and uses:

backend

  1. PostgreSQL as the database
  2. KanIDM as the IAM backend
  3. Meilisearch as the search engine

frontend

  1. SvelteKit as the web frontend

To get started building Articleman, all you need is the Nix package manager.

All of the dependencies you need to build Articleman are included in flake.nix, which can be automatically loaded by Nix with any of the below commands.

To run without Flakes enabled:

	$ nix-shell -A devShells.x86_64-linux.backend

	# --or--

	$ nix-shell -A devShells.x86_64-linux.frontend

	# where the architecture is whatever your computer is running, typically x86_64-linux

To run with Flakes enabled:

	$ nix develop .#backend

	# --or--

	$ nix develop .#frontend

Once you're there, just use Cargo or the Yarn package manager in the corresponding directory as you usually would.

To build the frontend through nix, just run nix build .#frontend.

About

Open-source publication management that lets you work less and get more done.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •