Skip to content
FactuStorm Docs

Quick Start

Welcome to the SaaS Auth API documentation! This guide will help you get started with implementing authentication and authorization in your SaaS application.

Prerequisites

Before you begin, make sure you have:

  • Go 1.24.1 or higher installed
  • Docker and Docker Compose installed
  • Basic understanding of REST APIs and authentication concepts

Installation

  1. Clone the repository:
Terminal window
git clone https://github.com/yersonargotev/saas-auth-api.git
cd saas-auth-api
  1. Set up your environment variables:
Terminal window
cp .env.example .env
  1. Start the development environment:
Terminal window
docker-compose -f docker-compose.dev.yml up

Basic Usage

Authentication

The API provides several endpoints for user authentication:

  • POST /api/v1/auth/register - Register a new user
  • POST /api/v1/auth/login - Login with existing credentials
  • POST /api/v1/auth/refresh - Refresh access token
  • POST /api/v1/auth/logout - Logout user

Authorization

For protected routes, include the JWT token in the Authorization header:

Terminal window
Authorization: Bearer <your_jwt_token>

Next Steps

  1. Review the API Documentation for detailed endpoint information
  2. Check out the Development Guide for local development setup
  3. Follow the Security Guidelines for best practices

Support

If you encounter any issues or have questions: