Getting Started

Welcome to the EDMS backend services documentation! This guide will help you get started with the essential components of our system.

Prerequisites

Before diving into the documentation, ensure you have the following prerequisites:

• Basic understanding of web development concepts
• Familiarity with RESTful APIs and JSON
• Access to the EDMS backend services repository

Key Components

The key components of the EDMS backend services include:

• User Management
• Document Storage
• Workflow Automation
• API Gateway
• Security and Authentication

Getting Started

To get started with the EDMS backend services, follow these steps:

1. Clone the Repository: Clone the EDMS backend services repository to your local machine.

   git clone https://github.com/dinokage/edms-backend-fastify.git
   cd edms-backend-fastify

2. Environment Setup: Create a .env file in the root directory and configure the necessary environment variables. You can use the provided .env.example as a reference.

   cp .env.example .env

3. Ensure Docker is Running: Make sure Docker is running on your machine. The EDMS backend services use Docker for containerization.
4. Start the Services: Use Docker Compose to start the backend services.

   docker-compose up -d

5. Access the API: Once the services are running, you can access the API at http://localhost:3000/health to check its status. Use tools like Postman or cURL to interact with the API endpoints.
6. Explore the Documentation: Refer to the API documentation for detailed information on available endpoints, request/response formats, and examples.