Do NOT edit this README. Go to apps/README.md to view and edit user README
Built from https://github.com/es-labs/express-template.
For template design principles, see https://github.com/ais-one/cookbook#important---read-me-first
1 - Setup to allow incoming merge from upstream template update
# run once only after you `clone`, or `fork` or `delete .git and run git init`
./setup-upstream.sh2 - Setup for your custom code
# setup your env file
cp apps/.env.sample apps/.env # secret properties can be in apps/.env.secretImportant notes
- DO NOT develop custom code in
apps/app-sample. Rename it or copy it to another folder name - In apps/apploader.js, change
app-sampleto the folder you are using - userland changes ONLY in the
appsfolder, NEVER outside the folder. Contact template maintainer if you need something outsideapps - do note any conflicts to resolve when merging from upstream
3 - Updating the template
# Commit and push to remote before running commands below
git fetch upstream # includes tags
git pull upstream <branch or tag> --no-rebase
# NO MORE IN USE git merge upstream/<branch or tag> --allow-unrelated-histories
# There may be some template related merge conflicts to resolve.Suggested Conventions
- branch
- main = stable
- work = working branch
- feat-
- bugfix-
- release tags
- use semver, e.g. 1.2.3
- should tag main branch
# clone repo
git clone https://github.com/es-labs/express-template.git
cd express-template
npm i
cd apps
npm i
# Note your custom development folder is `<project root>/apps/app-sample`
cd .. # go back up
npm run local # see ./package.json scripts
# For Windows OS: npm run local:win
# OR to run eslint checks - linux
NODE_ENV=development npm run lintLocal development sample sqlite DB apps/app-sample/dev.sqlite3 already created and populated
If need to migrate and seed, refer to dbdeploy package in tools workspace of https://github.com/es-labs/jscommon
Visit the following URLs
- http://127.0.0.1:3000/api/healthcheck - app is running normally
- http://127.0.0.1:3000 - Website served by Express with functional samples and demos
- http://127.0.0.1:3000/docs - OpenAPI documentation
- http://127.0.0.1:3000/native/index.html -
NOTES
- No bundler frontend
- import only vue & vue-router at index.html, pure vanilla JS no webpack or other bundler
- export const store = reactive({}) used instead of Vuex
Unit & Integration Tests:
- To run unit & integration test on /api/categories endpoint. E2E testing is Work In Progress
- TO TEST EVERYTHING PLEASE change describe.only(...) to describe(...) in the test scripts in apps/app-sample/tests
See package.json
# run in development only
npm run testFor running using docker/podman
docker build -t express-template --target production --build-arg ARG_NODE_ENV=dev --build-arg ARG_API_PORT=3000 .
docker run -p 3000:3000 express-templateSee https://github.com/es-labs/vue-antd-template for a SPA frontend template that can be used with projects based on this template
See apps/README.md
Features include SAML. OIDC, OAuth, Fido2 login, Push Notifications
- .github/workflows/deploy-cr.yml TODO
- selectable inputs
- git repo branch / tag
- container repo tag
- selectable inputs
Build image and deploy to a container registry
NOTE secrets will not be in repo for CI/CD, those should be put in VAULT
Current Github Secrets
- CR_USERNAME: container registry login username (for deployment)
- CR_PASSWORD: container registry login password (for deployment)
Current Github Variables
- CR_HOST: container registry host (for deployment)
- CR_NS: container registry namespace (for deployment)
- CR_IMAGENAME: The image name. If not specified, the repository name will be used
