Skip to content

Commit cf97568

Browse files
committed
SEBSERV-832: update docs
1 parent 0e877ff commit cf97568

3 files changed

Lines changed: 13 additions & 26 deletions

File tree

README.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,47 +10,33 @@ This is a sub-project of SEB Server. For full usage and installation, please vis
1010

1111
This project consists of two parts. A client component and a server component. The server contains no businesses logic but serves as a lightweight api-gateway between the client and the [SEB-Server](https://github.com/SafeExamBrowser/seb-server). The easiest way to build and deploy the project is via docker.
1212

13-
### Client
14-
15-
The client uses the following technologies:
16-
17-
#### [VueJs Version 3.4.\*](https://vuejs.org/)
18-
19-
- Composition API and Script Setup Syntax
20-
- Typescript
21-
- [Vuetify](https://vuetifyjs.com/en/) as the componenet framework
22-
23-
### Server
24-
25-
The server uses the following technologies:
26-
27-
#### [ExpressJs Version 4.19.\*](https://expressjs.com/)
28-
29-
- Typescript
30-
- Axios as API-Request library
31-
3213
# Development Setup
3314

3415
## Intro
3516

36-
If you're just working on the frontend part (SEB Server GUI), this is the easiest way to have a working environment. This pulls the backend services (mariadb, seb-server and sps-webservice) from existing images. The frontend services (fe-server and fe-client) are built from the local code of this repository.
17+
If you're just working on the frontend part (SEB Server GUI), this is the easiest way to have a working environment. This pulls the backend services (mariadb, seb-server and sps-webservice) from existing images
3718

3819
## Setup docker containers
3920

4021
1. Run `docker-compose up -d`
41-
1. Visit http://localhost:8082 and login to confirm that the full setup works
4222

4323
## Setup the client
4424

4525
1. `cd client`
4626
1. Start virtual node env: `nvm use`
4727
1. Install dependencies: `npm ci`
48-
1. Copy the example .env file and adapt it to your needs: `cp .env.example .env`
28+
1. Copy the example `.env` file and adapt it to your needs: `cp .env.example .env`
4929
1. Start the client: `npm run dev`
5030

51-
## Install the pre-commit hook
31+
## Setup the server
32+
33+
1. See `README.md` in `/server`
34+
35+
## Confirm setup worked
5236

53-
The following steps have to be done on your **host machine** (not in the docker-container)
37+
1. Visit http://localhost:8082 and login to confirm that the full setup works
38+
39+
## Install the pre-commit hook
5440

5541
1. Run `cd client && nvm use && npm run prepare`
5642
1. Run `git config core.hooksPath` and verify, that the `hooksPath` was correctly set to `./client/.husky/_`

docker-compose.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,8 @@ services:
113113
- "mariadb"
114114
restart: unless-stopped
115115

116-
# uncomment this if you don't want to run the seb-server-gui yourself
116+
# Uncomment this if you don't want to run the seb-server-gui yourself
117+
# You have to run `docker build -t seb-server-gui:local .` for building the image before starting the container
117118
# seb-server-gui:
118119
# image: "seb-server-gui:local"
119120
# container_name: seb-server-gui

proxy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
1. Start virtual node env: `nvm use`
66
1. Install dependencies: `npm ci`
7-
1. Copy the example .env file and adapt it to your needs: `cp .env.example .env`
7+
1. Copy the example `.env` file and adapt it to your needs: `cp .env.example .env`
88

99
## Dev
1010

0 commit comments

Comments
 (0)