Psephos Documentation

Here you can find the API documentation for the various components of the Psephos project.

Project Goal

The main goal of the project is to provide a simple and easy to use API for developing client applications. The API should be easy to extend and maintain. The project follows RESTful API design principles. You can connect using HTTP or WebSockets.

Features

• RESTful API
• WebSockets API
• Registration and Authentication
• Attribute Based Access Control
• User Management
• Support for Groups and Organizations
• Creation and Management of Polls
• ...

Quick Navigation

Usage Documentation

• API Overview - Learn about the main components and architecture
• Quick Start Guide - Get up and running quickly
• Authentication - Learn how to authenticate with the API
• Permission System - Understand how permissions work
• Configuration - Configure the API for your environment
• Deployment - Deploy the API to production
• API Reference - Complete API endpoint documentation
• OpenAPI - Interactive API documentation

Development Documentation

• Development Quick Start - Get started with development
• Project Structure - Understand the codebase organization
• Libraries and Dependencies - Learn about the tech stack
• Testing - Run and write tests
• Release Process - How to create releases

Resources

• Changelog - See what's new in each version