Skip to content
Muslih Ali edited this page Sep 15, 2024 · 1 revision

Welcome to the Paswad Wiki πŸ›‘οΈπŸ”‘

This Wiki serves as the central repository for all documentation related to Paswad, a state-of-the-art authentication service. It provides comprehensive details on how to get started, integrate, and contribute to the project.

Table of Contents πŸ“š

  1. Overview
  2. Installation Guide
  3. API Documentation
  4. Usage Examples
  5. Contributing
  6. FAQs
  7. Roadmap
  8. Changelog
  9. Contact

Overview

Paswad is designed to be a lightweight and secure authentication service that employs JWTs (JSON Web Tokens) for user authentication. It supports stateless authentication, making it highly scalable and efficient. The project leverages modern C++ features, PostgreSQL for robust data management, ZeroMQ for high-performance messaging, and Nlohmann JSON for streamlined JSON handling.


Installation Guide πŸš€

This section provides detailed instructions on how to set up Paswad on your local machine or server.

Prerequisites πŸ› οΈ

  1. C++ Compiler: A modern C++ compiler (e.g., GCC, Clang) that supports C++11 or higher.
  2. PostgreSQL: Database system installed and configured.
  3. ZeroMQ: Messaging library for efficient communication.
  4. Nlohmann JSON: Library for handling JSON.

Installation Steps πŸ”§

  1. Clone the Repository

    git clone https://github.com/yourusername/paswad.git
    cd paswad