4
4
This is the relaunch of the new www.vim.org website. We have found a small team that will take on the
5
5
beautiful task of rebuilding the website with current design and new concepts.
6
6
7
- The new development should not take place behind closed doors, we want to
7
+ The new development should not take place behind closed doors, we want to
8
8
make the new development public and transparent for you.
9
9
10
10
Soon there will be a test system where you can follow the current status successively.
11
11
12
12
Of course, we will involve you, the community, in the design by collecting ideas and feedback.
13
13
14
- # Getting started
14
+ # Build
15
15
16
- ## Prerequisites
16
+ Prerequisites
17
17
18
- * docker
18
+ * docker & docker-compose
19
+ * npm
19
20
20
- ## Quick start
21
+ ### Getting started
21
22
22
- The application can be run locally by executing the bash script ` local-startup.sh ` .
23
+ Run the application locally with these make commands ` make dev ` .
23
24
24
- ## Manual start
25
+ This will setup default configuration (including dummy secrets),
26
+ install npm dependencies and start the application using docker on port ` 3000 ` .
25
27
26
- The following steps must be carried out:
28
+ ### Build locally
29
+
30
+ The following steps must be carried out:
27
31
1 . Copy contents of ` .env.example ` files on ` root ` , ` root/cms ` and ` root/web ` into ` .env ` file
28
- 2 . Execute docker-compose file for local environment with the following command: ` docker compose -f docker-compose.local.yml up `
32
+ 2 . Install npm dependencies with ` npm install ` in the ` root ` , ` root/cms ` and ` root/web ` folder.
33
+ 3 . Startup: ` docker compose -f docker-compose.local.yml up `
29
34
30
35
For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/
31
36
@@ -44,7 +49,7 @@ Add your requirements here:
44
49
## Non-Functional Requirements
45
50
46
51
* We want to continue using MySQL 8 as the database system.
47
- * We want the website to be fundamentally secure and avoid typical web application vulnerabilities (like SQL injection, XSS, ...) by design.
52
+ * We want the website to be fundamentally secure and avoid typical web application vulnerabilities (like SQL injection, XSS, ...) by design.
48
53
* The hashing of the user passwords is to be migrated to a hashing procedure that corresponds to the state of the art.
49
54
* The frontend/backend stack shall:
50
55
- should be maintainable and expandable in the future with reasonable effort
0 commit comments