diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 214b48fd2..eebb83c08 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -27,6 +27,7 @@ export default withMermaid( { text: "Installation Guide", link: '/guide/install' }, { text: "Contribution Guide", link: "/guide/contribution"}, { text: "Translation Guide", link: "/guide/translations"}, + { text: "Developers Guide", link: "/guide/develop"}, { text: "Architecture", link: "/guide/architecture"}, { text: "Testing", link: "/guide/testing"} ] @@ -37,18 +38,26 @@ export default withMermaid( { text: 'License', link: '/license' } ], - sidebar: [ - { - items: [ - { text: "Users Guide", link: '/guide/user' }, - { text: "Installation Guide", link: '/guide/install' }, - { text: "Contribution Guide", link: "/guide/contribution"}, - { text: "Translation Guide", link: "/guide/translations"}, - { text: "Architecture", link: "/guide/architecture"}, - { text: "Testing", link: "/guide/testing"} - ] - } - ], + sidebar: { + '/guide/': { + items: [ + { + base: '/guide/', + collapsed: false, + text: 'Guides', + items: [ + { text: "Users Guide", link: 'user' }, + { text: "Installation Guide", link: 'install' }, + { text: "Contribution Guide", link: "contribution"}, + { text: "Translation Guide", link: "translations"}, + { text: "Developers Guide", link: "develop"}, + { text: "Architecture", link: "architecture"}, + { text: "Testing", link: "testing"} + ] + } + ] + }, + }, socialLinks: [ { icon: 'github', link: 'https://github.com/Sybit-Education/Diveni' }, diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css index 1b5f4d1d4..3469ea4c2 100644 --- a/docs/.vitepress/theme/custom.css +++ b/docs/.vitepress/theme/custom.css @@ -11,6 +11,6 @@ z-index: 21; } -.go-to-top .icon-top{ +.go-to-top .icon-top { color: #8bc34a; } diff --git a/docs/guide/develop.md b/docs/guide/develop.md index 5b95a146a..e9fc97c76 100644 --- a/docs/guide/develop.md +++ b/docs/guide/develop.md @@ -7,27 +7,47 @@ See also: * [Code of Conduct](../code_of_conduct) * [Contribution](./contribution) -## Installation +## Preconditions / Installation -### Technical Requirements +### Java Environment -- Java 17 - - Download from SAPMachine - ![Download_Selection_Java11](../img/Java17_Installer_Selection.png) - - Select the appropriate installer for your OS +Java 17 is required. We suggest SAPMachine. + +- Download SAPMachine +- Select the appropriate installer for your OS + +![Download_Selection_Java17](../img/Java17_Installer_Selection.png) + - Gradle - Download from Gradle official site -- Node.js - - Download from nodejs - ![Download_Selection_nodejs](../img/nodejs_Installer_Selection.png) - - Select the appropriate installer for your OS -- MongoDB - - MongoDB is running in the background at port 27017 + +### Frontend + +Node.js is required. We suggest Node.js 16 LTS. + +- Download from nodejs +- Select the appropriate installer for your OS + +![Download_Selection_nodejs](../img/nodejs_Installer_Selection.png) + + +### Database: MongoDB + +MongoDB is running in the background at port 27017 - ![Download_Selection_MongoDB](../img/MongoDB_Installer_Selection.png) - Select the appropriate installer for your OS and follow the instructions -### Setup Project +#### Docker + +On Linux/WSL, you can also use Docker to run MongoDB: + +```bash +docker pull mongodb/mongodb-community-server +docker run -p 27017:27017 --name mongo -d mongodb/mongodb-community-server +``` + +## Setup Project 1. Clone repository with Git from GitHub:
*git clone https://github.com/Sybit-Education/Diveni.git*