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
+10-24Lines changed: 10 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,47 +10,33 @@ This is a sub-project of SEB Server. For full usage and installation, please vis
10
10
11
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.
12
12
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
-
32
13
# Development Setup
33
14
34
15
## Intro
35
16
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
37
18
38
19
## Setup docker containers
39
20
40
21
1. Run `docker-compose up -d`
41
-
1. Visit http://localhost:8082 and login to confirm that the full setup works
42
22
43
23
## Setup the client
44
24
45
25
1.`cd client`
46
26
1. Start virtual node env: `nvm use`
47
27
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`
49
29
1. Start the client: `npm run dev`
50
30
51
-
## Install the pre-commit hook
31
+
## Setup the server
32
+
33
+
1. See `README.md` in `/server`
34
+
35
+
## Confirm setup worked
52
36
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
54
40
55
41
1. Run `cd client && nvm use && npm run prepare`
56
42
1. Run `git config core.hooksPath` and verify, that the `hooksPath` was correctly set to `./client/.husky/_`
0 commit comments