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

edit installation.md and update utilities.sh and mkdocs

parent 32d429c3
No related branches found
No related tags found
No related merge requests found
......@@ -4,8 +4,6 @@ docs/tech/architecture/definitions.md
docs/tech/architecture/CHANGELOG.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
......@@ -4,18 +4,20 @@ The INJECT Exercise Platform comprises two main components: the frontend and the
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
Before you begin, ensure that you have the following: a server with at least 1 core CPU and 4GB RAM, a 64-bit x86 architecture and root or sudo access to the server. This ensures that the backend server can handle data processing efficiently while serving the frontend interface smoothly.
The installation files for deployment are zipped and available on GitLab. You can download them from the following location:
```
https://gitlab.fi.muni.cz/inject/inject-docs
```
These files include all necessary configuration files, scripts, and the .env file needed for deployment.
{%
include-markdown "../../files-from-repos/nginx-README.md"
%}
## Manual Installation
For manual installation of the frontend and backend components without Nginx integration, please refer to the [Manual Installation Guide](manual-install.md).
# Conclusion
## Conclusion
By following the installation guide, 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.
By following the installation guide, you'll be able to successfully set up and run the INJECT Exercise Platform. If you encounter any bugs or require further assistance, don't hesitate to report them to us. The [Report bugs](../report-bugs.md) includes instructions on how to report bugs.
## 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. 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
File added
......@@ -17,7 +17,6 @@ nav:
- 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
......
......@@ -8,5 +8,4 @@ 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
zip -r ./files-from-repos/deployment-files.zip ./frontend/docker/nginx-deployment/
\ 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