From 6cbdcc7361b3ded4e53caffd3c9338b18edf7417 Mon Sep 17 00:00:00 2001 From: "Wei-Cheng Yeh (IID)" Date: Wed, 20 Mar 2024 18:19:40 +0800 Subject: [PATCH] docs(README.md): explain "Edit and Apply Configuration" --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index e7260df..9bd3a68 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,24 @@ The corresponding backend repository of this website is: The architecture is based on [中台架構-站台部屬規劃(20210126版本for測試計畫)](https://hackmd.io/@twbbs/Root#%E6%9E%B6%E6%A7%8B%E5%9C%96). +## Edit and Apply Configuration + +Configuration is required for running this demo. + +You can refer to examples `config.test/` or `config.tmpl/` for setting up your own configuration. + +Your project directory needs to have the following file layout: + +* `config/` - your configuration directory (must be this name) + * `index.js` - contains all the configuration needed by the project. + * Ensure that `API_ROOT` has been set to the API URL of a running openbbs-middleware instance. + +When done editing `index.js`, remember to copy `config/` into the directory `node_modules/`. + +```sh +cp -r config node_modules/ +``` + ## Starting server at localhost ``` sh