Skip to content
Snippets Groups Projects
Commit 95ca1e45 authored by Roman Dvořák's avatar Roman Dvořák
Browse files

update overviews content

parent 4a411b84
No related branches found
No related tags found
No related merge requests found
The INJECT API is designed to facilitate communication between the frontend and backend components of the INJECT platform. It enables clients to perform various operations, including data retrieval, manipulation, and real-time updates.
### GraphQL API
The GraphQL API provides a flexible and efficient way to interact with the INJECT platform. It allows clients to query specific data fields, reducing over-fetching. The [GraphQL documentation](graphql-docs.md) provides detailed information about the available queries, mutations, and subscriptions, along with examples and usage guidelines.
### REST API
The REST API complements the GraphQL API by providing additional functionality and support for file transfers and other operations not supported by GraphQL. The [REST documentation](swagger-docs.md) covers endpoints, request methods, parameters, and response formats, offering comprehensive guidance for integrating with the INJECT platform.
\ No newline at end of file
## INJECT Project Overview
The INJECT project is a comprehensive platform designed to streamline the process of designing, performing, and evaluating tabletop exercises. Traditionally, conducting tabletop exercises can be time-consuming and costly. However, the INJECT platform aims to make tabletop exercises more accessible to organizations of all sizes and industries.
## Key Components
### Backend Architecture
* Python Backend: The backend of the INJECT platform is implemented using Python, a popular and versatile programming language.
* Django Framework: Django, the most popular web development framework for Python, is used to build the backend application. Django provides robust features for database management, user authentication, and more.
* GraphQL API: The backend exposes a GraphQL API for communication with the frontend. GraphQL allows efficient data fetching and enables the client to request only the data it needs.
* Django REST Framework: For file transfers and other functionalities not supported by GraphQL, a REST API is implemented using Django REST Framework.
### Frontend Architecture
* React Frontend: The frontend application of the INJECT platform is developed using React, a powerful library for building user interfaces.
* TypeScript: TypeScript is used instead of JavaScript to ensure type safety and improve code quality.
* React Hooks: React hooks play a crucial role in modern React programming, providing essential features such as state management and performing side effects.
* Libraries and Tools: Various libraries and tools, including Yarn, Vite, Apollo Client, and Generouted, are utilized for package management, building, data management, and routing within the frontend application.
\ No newline at end of file
## Installation Guides
### Frontend Installation Guide
The frontend of the INJECT project is responsible for providing a user-friendly interface for interacting with exercises and educational content. To get started with the frontend installation and configuration, refer to the [Frontend Installation Guide](front-README.md). This guide will walk you through the necessary steps to set up the frontend environment, install dependencies, and deploy the frontend application.
### Backend Installation Guide
The backend of the INJECT project handles data management, authentication, and running the INJECT project. To begin setting up the backend environment and running the backend server, follow the instructions outlined in the [Backend Installation Guide](back-README.md). This guide provides detailed steps for installing dependencies, configuring the backend, and deploying the backend server.
By following the installation guides for both the frontend and backend components, you'll be able to successfully set up and run the INJECT project. If you encounter any issues or need further assistance, please check out our [FAQ](TBA). Additionally, if you encounter any bugs or require further assistance, don't hesitate to report them to us.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment