Skip to content
This repository was archived by the owner on Jun 28, 2025. It is now read-only.

Commit d579bc0

Browse files
docs(README): update build section
- remove trailing spaces - revise doc structure - remove local-startup.sh script and replace with make target - list port application is running under
1 parent 4140481 commit d579bc0

File tree

3 files changed

+18
-31
lines changed

3 files changed

+18
-31
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,33 @@
44
This is the relaunch of the new www.vim.org website. We have found a small team that will take on the
55
beautiful task of rebuilding the website with current design and new concepts.
66

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
88
make the new development public and transparent for you.
99

1010
Soon there will be a test system where you can follow the current status successively.
1111

1212
Of course, we will involve you, the community, in the design by collecting ideas and feedback.
1313

14-
# Getting started
14+
# Build
1515

16-
## Prerequisites
16+
Prerequisites
1717

18-
* docker
18+
* docker & docker-compose
19+
* npm
1920

20-
## Quick start
21+
### Getting started
2122

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`.
2324

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`.
2527

26-
The following steps must be carried out:
28+
### Build locally
29+
30+
The following steps must be carried out:
2731
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`
2934

3035
For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/
3136

@@ -44,7 +49,7 @@ Add your requirements here:
4449
## Non-Functional Requirements
4550

4651
* 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.
4853
* The hashing of the user passwords is to be migrated to a hashing procedure that corresponds to the state of the art.
4954
* The frontend/backend stack shall:
5055
- should be maintainable and expandable in the future with reasonable effort

local-startup.sh

Lines changed: 0 additions & 18 deletions
This file was deleted.

makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ install:
5656

5757
init-env:
5858
test -f .env || cp .env.example .env
59-
test -f web/.env || cp .env.example web/.env
59+
cd web/ && ( test -f .env || cp .env.example .env )
6060
cd cms/ && ( test -f .env || cp .env.example .env )
6161
@echo '-----------------------------------------------------'
62-
@echo 'please update the .env files with the missing secrets'
62+
@echo 'please update the default secrets in the .env files'
6363

6464
check-env:
6565
./scripts/check-env.sh .env.example .env
66-
./scripts/check-env.sh .env.example web/.env
66+
./scripts/check-env.sh web/.env.example web/.env
6767
./scripts/check-env.sh cms/.env.example cms/.env
6868

6969
logs:

0 commit comments

Comments
 (0)