From 475ce99ce1a0f9f73aa9153bfb625b174cc326a6 Mon Sep 17 00:00:00 2001 From: Prev Date: Mon, 12 Mar 2018 14:07:58 +0900 Subject: [PATCH] Update README, add Basic Auth Key of cloudant --- .gitignore | 5 +++-- README.md | 8 ++++---- config.json | 4 ++-- templates/README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 57 insertions(+), 8 deletions(-) create mode 100644 templates/README.md diff --git a/.gitignore b/.gitignore index 8367f1d..f792285 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .jikji -generated/ __pycache__ /_* -venv/* \ No newline at end of file +venv/ +generated/ +rexpress.github.io/ \ No newline at end of file diff --git a/README.md b/README.md index 9d37c93..54f98c1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#rexpress/web-res +# rexpress/web-res Web resources be used in **http://regular.express** @@ -8,12 +8,12 @@ Web resources be used in **http://regular.express** ### Dependency -Web site is rendered with **[Jikji](https://github.com/Prev/jikji)** (Static website generator based on RESTFul Server). +Web site is rendered with **[Jikji v0.5](https://github.com/Prev/jikji/tree/0.5)** (Static website generator based on RESTFul Server). `jikji` use [Jinja2](http://jinja.pocoo.org/) template engine which is used in [Flask](http://flask.pocoo.org/). You can see jinja template documentation on [here](http://jinja.pocoo.org/docs/dev/templates/). -Environment datas are loaded from [rexpress/environments](https://github.com/rexpress/environments). +Environment datas are loaded from repository [rexpress/environments](https://github.com/rexpress/environments). @@ -29,6 +29,6 @@ Environment datas are loaded from [rexpress/environments](https://github.com/rex ### Build -[regular.express](http://regular.express) is built automatically for every hour by Jenkins. +[regular.express](http://regular.express) is built automatically for every hour by Jenkins. Currently stopped. Commits in the `master` branch will be reflected as soon as they are built. \ No newline at end of file diff --git a/config.json b/config.json index b70755e..d50036e 100644 --- a/config.json +++ b/config.json @@ -3,13 +3,13 @@ "type": "cloudant", "baseurl": "https://rexpress.cloudant.com/", "headers": { - "Authorization": "" + "Authorization": "Basic b3V0aW91cnN0YW5kZXZpc3NlZGxlZGxvOmQzNTEwYmI0YzAzYmNjNzI2NjZlMmI0YzBiMTExMjZmNmY0NDc0MDk=" } }, "path": { "template": "templates", - "output": "generated", + "output": "rexpress.github.io", "assets": ["assets"], "pages_xml": "pages.xml" }, diff --git a/templates/README.md b/templates/README.md new file mode 100644 index 0000000..c9a1b57 --- /dev/null +++ b/templates/README.md @@ -0,0 +1,48 @@ +# regular.express + +[regular.express](http://regular.express) is static website powered by Github Pages. + +We use special library **[Jikji](https://github.com/Prev/jikji/tree/0.5)** to automate rendering pages. Datas are stored in [Cloudant](https://www.ibm.com/cloud/cloudant), which is document database service powered by IBM. + + + +## Build manually + +Originally, this website is built automatically for every hour by Jenkins. But now it stopped by cost problem. + +However, you can build this website manually with terminal and `git` + + +### How to build & test service + +```bash +$ git clone https://github.com/rexpress/web-res +$ cd web-res +$ pip install -r requirements.txt # or use pip3 +$ python -m jikji . listen # or use python3 +``` + +Then you can see website in `http://localhost:7000` + + +### Commit a website + +Install `web-res` and then run command. + +1. Fork [https://github.com/rexpress/rexpress.github.io](https://github.com/rexpress/rexpress.github.io). + +2. Run command below. + +```bash +$ git clone https://github.com/{YOUR_NICK_NAME}/rexpress.github.io +$ python -m jikji . generate +$ cd rexpress.github.io +$ git add * +$ git commit -am "Build manually" +$ git push +``` + +3. Make a pull request to `rexpress/rexpress.github.io` +4. We will accept for it! + +