the-demo-site v11.0.15

the-demo-site

Demo site of the-framework

Table of Contents

• the-demo-site
  • Requirements
  • Preparing
  • Development
    • Starting Development Server
    • Open Project In Browser
  • Production
    • Setup Server (Ubuntu)
    • Setup App
    • Configure Reverse Proxy
  • Running Tasks
    • Core Tasks
    • Dev Only Tasks
  • Database
    • Database Resource
    • Console to database
  • E2E (End-to-End) Test
    • Set Up Servers
    • Run E2E Test
  • Trouble Shooting
    • First Things You Should Try
    • Docker Containers Seam to Be Dead
  • Misc
    • Provided Urls
    • Project Structure
    • What is .*.bud Files?
    • Configuring Secret Values
  • License
  • Links

Requirements

This project requires:

• Node.js >=10
• Docker

Preparing

Install CLI packages if you have not

# Install global dependencies
npm i -g pon pm2 jsdoc mocha

Then, install dependencies and build the project

# Install dependencies and trigger prepare script
npm install

Development

Starting Development Server

# Start server and watch files to compile
pon debug  # Or just `pon d`

Open Project In Browser

# This will the open in your browser
open open  # Or just `pon o`

Production

Setup Server (Ubuntu)

Execute ./misc/setup/setup_ubuntu.sh to install softwares like git, node, nginx, etc.

Setup App

# Setup env
export NODE_ENV=production

# Where you checkout the project
cd /opt/apps/the-demo-site

# Install dependencies and run prepare scripts
yarn install


# Interactive shell to configure local values
pon setting


# Start production server
pon production

Configure Reverse Proxy

# Setup cert files for https
./misc/deploy/01.cert.sh

# Apply https setting for nginx
./misc/deploy/02.vhost.sh

# Configure cert renew with cron
./misc/deploy/03.crontabs.sh

Running Tasks

This project uses Pon as a task runner.

Just pass task name to run.

pon <taskName>

Core Tasks

Tasks defined in Ponfile.js

Dev Only Tasks

Tasks defined in Ponfile.dev.js

For more information, try pon -l

Database

Database Resource

• Alias Resource
• History Resource
• Profile Resource
• Role Resource
• Sign Resource
• Token Resource
• User Resource

Console to database

pon db:cli

In the console, you can access database resources via ClayResource class

Terminal Example

Welcome to the-db prompt!
DB Env: { dialect: 'mysql', host: 'localhost', port: '6002', database: 'thedemosite_dev', username: 'thedemosite_dev', root_username: 'root', hooks: null }
DB Resources: [ 'TheDBSchema', 'TheDBLog', 'Alias', 'History', 'Profile', 'Role', 'Sign', 'User' ]

the-db> User.count()  # Evaluate One-line Javascript in the terminal
106
the-db> (await User.first()).name  # Using async interface
'superadmin-71d5acfe'
the-db>

E2E (End-to-End) Test

Set Up Servers

Run app server with debug mode

pon debug:server # Or just `pon ds`

Then, run e2e server (In other tab)

pon e2e:listen # Or just `pon el`

Run E2E Test

To run all tests,

pon e2e # Or just `pon e`

To run single tests,

# List available test stories
pon -l e2e:story

# Example to run one of stories
pon e2e:story/signInOut 

Trouble Shooting

First Things You Should Try

When something goes funny, the first thing to do is clean and build

# Clean up files and build again (aka. `pon c b`)
pon clean build

Docker Containers Seam to Be Dead

To Re-create docker containers,

# Remove docker containers and restart again
pon docker:*/remove docker

Misc

Provided Urls

• /about/app
• /about/privacy-policy
• /about/terms-of-use
• /account/mypage
• /account/password
• /account/profile
• /account/quit
• /account/recover/reset
• /account/recover/send
• /account/verify/confirm
• /admin
• /admin/users
• /a/:key
• /build/bundle.css
• /css/flatpickr.min.css
• /css/fontawesome-all.css
• /css/normalize.css
• /css/theme.css
• /errors/forbidden
• /errors/not-found
• /images/app-icon.png
• /build/bundle.js
• /build/external.js
• /RootServiceWorker.js
• /js/es5-shim.min.js
• /manifest/:lang/manifest.json
• /v11.0.15
• /v11.0.15/bundle.css
• /v11.0.15/bundle.js
• /v11.0.15/external.js
• /sign/please
• /sign/signin
• /sign/signout
• /sign/signup
• /

Project Structure

Directory structure of this project

What is .*.bud Files?

This project contains a lot of .*.bud files, which is used by coz file generator. Bud file tells coz to how files should to generate, like path,tmpl,data,mode, etc.

Configuring Secret Values

Secret values are stored in secrets.json These values can be encoded/decoded by pon tasks

# Decode values inside secrets.json
pon secret:dec

# Encode values inside secrets.json
pon secret:enc

License

This software is released under the Apache-2.0 License.

Links

• Pon
• ClayResource API