README.md

semantic.works

A website built to be...

• ... an introduction & documentation to semantic.works and our microservice tech stack
• ... a live example of the power of Ember.js and our microservice app-mu-info
  • ... the latter of which allows us to write our documentation inside of our repositories and have it update everywhere, as well as switch between Git hosts where needed
• ... be independent of CDN's (w.i.p., see #3)

How-To

Install & run

npm install
npm run dev  # In case you get `ERR_OSSL_EVP_UNSUPPORTED`, run "export NODE_OPTIONS=--openssl-legacy-provider" (or use "npm run dev:ssl")

Make sure to have an instance of app-mu-info running, and that the --proxy argument in package.json is configured towards it.

Discussions

Env differences

The production environment (used in npm start & npm run build), the favicon is served from /assets/. In development (used in npm run dev) it's served by root

Reference

API & Data models

This project uses data from app-mu-info, and thus the models defined in app/models/ adhere to this. You can view the GitHub repository of app-mu-info here.

Project structure & used technologies

• Frontend:
  • Ember (v3)
  • Deployed using: Dockerfile
• Favicon:
  • Location: public/favicon.png
  • Handled by: Denperidge-Redpencil/ember-cli-favicon
  • Configured in: ember-cli-build.js
• Dynamic OpenGraph:
  • Handled by: ember-cli-head & app/utils.js
  • Configured in: app/routes/