Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved dev guide #482

Merged
merged 2 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
]
Expand All @@ -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' },
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
z-index: 21;
}

.go-to-top .icon-top{
.go-to-top .icon-top {
color: #8bc34a;
}
46 changes: 33 additions & 13 deletions docs/guide/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://sap.github.io/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 <https://sap.github.io/SapMachine/>
- Select the appropriate installer for your OS

![Download_Selection_Java17](../img/Java17_Installer_Selection.png)

- Gradle
- Download from Gradle official site <https://gradle.org/install/>
- Node.js
- Download from nodejs <https://nodejs.org/en/download/>
![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 <https://nodejs.org/en/download/>
- 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
- <https://www.mongodb.com/docs/manual/administration/install-community/>
![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:<br />
*git clone https://github.com/Sybit-Education/Diveni.git* <br />
Expand Down