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

rework installation documentation

parent e212d07b
No related branches found
No related tags found
No related merge requests found
......@@ -2,9 +2,10 @@
site/
docs/tech/architecture/definitions.md
docs/tech/architecture/CHANGELOG.md
docs/tech/installation/back-README.md
docs/tech/installation/front-README.md
docs/tech/api/openapi.yml
files-from-repos/nginx-README.md
files-from-repos/front-README.md
files-from-repos/back-README.md
# python
.python-version
## Overview
# Overview
The INJECT Exercise Platform comprises two main components: the frontend and the backend. This separation allows for modular development, easier maintenance, and scalability of the platform. Below, we'll walk you through the installation process for [frontend](#frontend-installation-guide) as well as for [backend](#backend-installation-guide).
The INJECT Exercise Platform comprises two main components: the frontend and the backend. This separation allows for modular development, easier maintenance, and scalability of the platform. Below, we'll walk you through the unified process of installation for frontend as well as for backend.
For a deeper understanding of the overall architecture of the INJECT Exercise Platform, you can refer to the [architecture overview](architecture/overview.md) in the documentation.
## Hardware Requirements
# Hardware Requirements
The INJECT Exercise Platform is designed to be lightweight and efficient, ensuring it can run on a wide range of hardware configurations. A minimum hardware configuration of a 1-core CPU and 4GB of RAM is recommended to ensure optimal performance. This ensures that the backend server can handle data processing efficiently while serving the frontend interface smoothly.
## Frontend Installation Guide
The frontend of the INJECT Exercise Platform is responsible for providing a user-friendly interface for interacting with exercises and educational content. To get started with the frontend installation and configuration. This guide will walk you through the necessary steps to set up the frontend environment, install dependencies, and deploy the frontend application.
{%
include-markdown "../../frontend/INSTALLATION.md"
include-markdown "../../files-from-repos/nginx-README.md"
%}
## Backend Installation Guide
## Manual Installation
The backend of the INJECT Exercise Platform handles data management, authentication, and running the INJECT Exercise Platform. This guide provides detailed steps for installing dependencies, configuring the backend, and deploying the backend server.
For manual installation of the frontend and backend components without Nginx integration, please refer to the [Manual Installation Guide](manual-install.md).
{%
include-markdown "../../backend/INSTALLATION.md"
%}
# Conclusion
By following the installation guides for both the frontend and backend components, you'll be able to successfully set up and run the INJECT Exercise Platform. If you encounter any issues or need further assistance, please check out our [FAQ](../faq.md). Additionally, if you encounter any bugs or require further assistance, don't hesitate to report them to us. The [FAQ](../faq.md) includes instructions on how to report bugs.
\ No newline at end of file
By following these steps, you should have the INJECT platform up and running on your server. If you encounter any issues or need further assistance, please check out our FAQ or report the issue to us. Thank you for choosing the INJECT platform!
\ No newline at end of file
## Frontend Installation Guide
The frontend of the INJECT Exercise Platform is responsible for providing a user-friendly interface for interacting with exercises and educational content. To get started with the frontend installation and configuration. This guide will walk you through the necessary steps to set up the frontend environment, install dependencies, and deploy the frontend application.
{%
include-markdown "../../files-from-repos/front-README.md"
%}
## Backend Installation Guide
The backend of the INJECT Exercise Platform handles data management, authentication, and running the INJECT Exercise Platform. This guide provides detailed steps for installing dependencies, configuring the backend, and deploying the backend server.
{%
include-markdown "../../files-from-repos/back-README.md"
%}
\ No newline at end of file
......@@ -14,8 +14,10 @@ copyright: Copyright © 2024 Masaryk University
nav:
- Home: index.md
- Technical documentation:
- Installation: tech/installation.md
- Technical documentation:
- Installation:
- Installation: tech/installation.md
- Manual installation: tech/manual-install.md
- System architecture:
- Overview: tech/architecture/overview.md
- Definition documentation: tech/architecture/definitions.md
......
......@@ -6,3 +6,6 @@ mkdir -p docs/tech
cp ./backend/definitions/README.md ./docs/tech/architecture/definitions.md
cp ./backend/CHANGELOG.md ./docs/tech/architecture/CHANGELOG.md
cp ./backend/openapi.yml ./docs/tech/api/openapi.yml
cp ./frontend/docker/nginx-deployment/README.md ./files-from-repos/nginx-README.md
cp ./frontend/INSTALLATION.md ./files-from-repos/front-README.md
cp ./backend/INSTALLATION.md ./files-from-repos/back-README.md
\ 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