Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 2.79 KB

README.md

File metadata and controls

63 lines (48 loc) · 2.79 KB
Raw

Traceability Matrix Manager API

Description

The Traceability Matrix API is tool designed provide the functionality to manage projects, traceability of records, and users with different roles. It provides a flexible and secure environment for tracking project-related activities.

Features and Highlights

  • User roles: Admin, Team Member, Guest.
  • Fine-grained permissions for each user role.
  • Project and record management.
  • Tracking record relationships by key.
  • Event recording for user actions.
  • API documentation using Postman collections.

Technologies Used

  • Django
  • Django REST Framework
  • Djoser
  • Django REST framework simple JWT
  • Postman (for API testing and documentation)

Version

Current version of the release: v1.0.0-beta

API Documentation

API documentation is available in Postman collections:

Getting Started

Installation

  1. Clone the repository or download the release version v1.0.0-beta.
git clone https://github.com/omarfrancodev/traceability-matrix-manager-API.git
  1. Install dependencies.
cd traceability-matrix-manager-API
pip install -r requirements.txt
  1. Apply migrations.
python manage.py migrate
  1. Run the development server.
python manage.py runserver

Important

A .env file must be created in the root directory of the project and the environment variables must be configured according to the settings of the database to be used.

Usage

Access the API documentation to explore available endpoints and actions.