You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-21Lines changed: 15 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,42 +8,36 @@ This is a sub-project of SEB Server. For full usage and installation, please vis
8
8
9
9
**This project is still under development and has not yet an official release or release data.**
10
10
11
-
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.
11
+
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. The easiest way to build and deploy the project is via docker.
12
12
13
-
### Client
13
+
#Development Setup
14
14
15
-
The client uses the following technologies:
15
+
## Intro
16
16
17
-
#### [VueJs Version 3.4.\*](https://vuejs.org/)
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
18
18
19
-
- Composition API and Script Setup Syntax
20
-
- Typescript
21
-
-[Vuetify](https://vuetifyjs.com/en/) as the componenet framework
19
+
## Setup docker containers
22
20
23
-
### Server
21
+
1. Run `docker-compose up -d`
24
22
25
-
The server uses the following technologies:
23
+
## Setup the client
26
24
27
-
#### [ExpressJs Version 4.19.\*](https://expressjs.com/)
25
+
1.`cd client`
26
+
1. Start virtual node env: `nvm use`
27
+
1. Install dependencies: `npm ci`
28
+
1. Copy the example `.env` file and adapt it to your needs: `cp .env.example .env`
29
+
1. Start the client: `npm run dev`
28
30
29
-
- Typescript
30
-
- Axios as API-Request library
31
+
## Setup the server
31
32
32
-
# Development Setup
33
+
1. See `README.md` in `/server`
33
34
34
-
## Intro
35
+
## Confirm setup worked
35
36
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.
37
-
38
-
## Setup docker containers
39
-
40
-
1. Run `docker-compose up -d`
41
37
1. Visit http://localhost:8082 and login to confirm that the full setup works
42
38
43
39
## Install the pre-commit hook
44
40
45
-
The following steps have to be done on your **host machine** (not in the docker-container)
46
-
47
41
1. Run `cd client && nvm use && npm run prepare`
48
42
1. Run `git config core.hooksPath` and verify, that the `hooksPath` was correctly set to `./client/.husky/_`
0 commit comments