/houraiteahouse.net-frontend

Front-end of http://houraiteahouse.net

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Discord

This is the frontend package for the Hourai Teahouse website. Thus far it was written with a "get pieces working" mindset rather than a proper design/plan and thus it requires significant UI/UX work to be public ready.

The source code is written to the Angular 1.x framework. ES2015 is used as the baseline for Javascript, using webpack, babel and core-js. CSSNext is used as the baseline for CSS, using postcss with postcss-cssnext.

To run it locally, use your choice of method (http-server on WebContent directory, nginx config, whatever). Sample nginx config has been provided. Make sure to update the port # in app.js as appropriate for how you're running the backend. In addition, make sure the server you use has URL rewriting enabled, so that the 'index.html' is returned for file paths that can't be resolved. A server that works well is spa-serve, installable via NPM.

Development

Setup

  1. Install NodeJS (6.x LTS) (For Linux users, go here.
  2. Run npm install in this directory.

Commands

  • Build: npm run build-all-development or npm run build-all-production.
  • Test: npm test

Major TODOs and Milestones:

  • UI/UX work
  • Public release
  • Additional features (wiki, issue tracker, etc)