Skip to content

Commit

Permalink
Update README, add Basic Auth Key of cloudant
Browse files Browse the repository at this point in the history
  • Loading branch information
Prev committed Mar 12, 2018
1 parent 05b1335 commit 475ce99
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 8 deletions.
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.jikji
generated/
__pycache__
/_*
venv/*
venv/
generated/
rexpress.github.io/
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#rexpress/web-res
# rexpress/web-res

Web resources be used in **http://regular.express**

Expand All @@ -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).



Expand All @@ -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.
<del>[regular.express](http://regular.express) is built automatically for every hour by Jenkins.</del> Currently stopped.

Commits in the `master` branch will be reflected as soon as they are built.
4 changes: 2 additions & 2 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
48 changes: 48 additions & 0 deletions templates/README.md
Original file line number Diff line number Diff line change
@@ -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!


0 comments on commit 475ce99

Please sign in to comment.