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
*`docker` (tested on Docker version 19.03.13-ce, build 4484c46d9d)
5
-
*`make` (not a strict requirement, but helps out with stages)
6
-
*`docker-compose` (tested on docker-compose version 1.27.4,)
7
-
8
-
## What
9
-
It is assumed you know what docker is.
10
-
You can build and run this project inside docker, headless. All the depencies will be downloaded in to the docker image.
11
-
12
-
## Why
13
-
There is no need to install node, or anything else (apart from above) on your machine to run this.
14
-
15
-
## How
16
-
17
-
1. Copy pasta the `.env-example` in to `.env`.
18
-
2. Edit `.env` in your favourite editor, pick stores, options what ever you want.
19
-
3. If you have make, simply run `make` in your terminal to get started. You should see a docker build, and container start automatically.
20
-
4. If you want a webserver running, so you can edit the options via web interface, uncomment lines 13-14 in `docker-compose.yml` to open up ports `7997`. Update `.env` file `WEB_PORT="7997"` this is so the service listens on `7997` and we expose the same ports on docker.
21
-
5. If you do not have make, because windows, run these commands in order:
See [Developing in docker](#developing-in-docker) for more information
53
+
52
54
## Customization
53
55
54
56
To customize streetmerchant, make a copy of `dotenv-example` as `dotenv` and make any changes to your liking. View [Reference](reference/application.md) for more information on variables and their usage.
55
57
56
-
57
-
## Building docker
58
-
59
-
[Docker-Docs](docs/docker.md)
60
-
61
58
???+ tip
62
59
All environment variables are optional.
63
60
64
61
## For developers
65
62
63
+
### Developing in Node.js
64
+
66
65
The command `npm run start:dev` can be used instead of `npm run start` to automatically restart the project when filesystem changes are detected in the `src/` folder or `dotenv` file.
66
+
67
+
Use `npm run lint` to see any linting uses and `npm run lint:fix` to automatically fix the issues it can.
0 commit comments