Edrak

Overview

Problem Statement

Edrak provides an efficient Electronic Document and Records Management System (EDRMS) that simplifies the management of a company's documents and records. It offers a centralized platform for the storage, tracking, and retrieval of documents, ensuring secure access to authorized personnel only.

Contribution

Prerequisites

Before contributing to or running the Edrak project, ensure the following:

sudo sysctl -w vm.max_map_count=262144

Common Issues

If you encounter issues, first check the logs:

$ docker-compose logs -f <service-name>

Example:

$ docker-compose logs -f server

If using Postman for testing, add the certificate from server/certs.

Usage:

Sample users for application testing:

1) Admin User:

Username: admin
Password: a

2) Manager User

Username: manager
Password: a

3) Viewer User

Username: viewer
Password: a

To test the system on https://edrak.rihal.dev, use these credentials:

1) Admin User:

Username: admin
Password: EdrakAdmin

Documentation

API Documentation

1. Open http://localhost:8081/api/v1/docs in your browser

2. Get access token using postman

3. Click on Authorize button

4. Enter Bearer <access_token> in the value field and click on Authorize button

Node: You can change the expiration time of the token from Keycloak admin console. Go to realm settings -> Tokens -> Access Token Lifespan

Deployment