Skip to content

Latest commit

 

History

History
110 lines (75 loc) · 4.59 KB

README.md

File metadata and controls

110 lines (75 loc) · 4.59 KB
Raw

Cricket

Angular Cricket

Get started

Download nodejs (10+) and npm (6.5+), download this project (it's a boilerplate, it is designed to be decoupled from original), and in the root, run

npm install -g @angular/cli typescript

Optionally you can create an ignored sub folder and install sekrab-gulpbin to use gulp tasks to prepare css files, from LESS files, and RTL files, in addition to commands to generate angular components, multilingual index files and locales.

Run

npm run install and npm run install:dev: will get you started with packages needed for this seed

Renaming

To rename every instance of "cricket" to a new name, find and replace the following

  • "cricket" -> "newname"
  • "Cricket" -> "Newname"
  • "cr" -> "nn" (angular selector prefix)
  • rename assets/js/cricket.js to newname.js

Cricket flavors

The main branch contains everything, different combinations are added in different branches.

Add explanation of each flavor here. [TODO:]

NPM commands

The following commands in npm to help you get going:

  • npm start: starts with normal english angular development (then browse to localhost:5100) serves index.dev.html with localdata/config.json
  • npm run start:prod: starts development server with production configuration and environment serves index.dev.prod.html with localdata/config.prod.json

  • npm run build generates a client-side angular app in /host/client

  • npm run build:ssr: builds the client-side and server-side full version under /host/client

Note: for multilingual apps, TODO: add docs for Angular builder

Notes:

  • Do not rename placeholder.html to index.html, there is a limitation in ngExpressEngine that it favores the index.html in output folder, over the one provided to render() function.
  • There are four route files in host/server folder, each with a different routing configuration to suit the project needs:
    • routes (client side only)
    • routes-url (client side only, language switch via url)
    • routes-ssr (server side)
    • routes-ssr-url (server side, language switch via url)
  • Known limitation with resources. I still depend on global resources.keys directly, to read resources on both client and server, depending on language cookie. This needs to be fixed so that the resources are fully loaded on server before use.
  • Build ssr task also takes care of generating RTL css links for all languages that support RTL. Setup languages supported in gulpfile/config.json, under languages collection.

Angular universal

This seed assumes a second project living in: host, where enough nodejs server code is created to run the server later. The npm task build:ssr creates : /client, and the creates server side files server/main.js, in addition to locales and index files. So the final tree of the host folder looks like this

|-client (angular output sits here)
|-server
|--------locale
|----other server files
|----main.js
|-index
|----index.en.html
|-server.js

Gulp commands for Angular

Gulp tasks has been moved to its own package under sekrab-gulpbin

You can optionally use these instead of the angular cli packaged commands (or you can create files manually). Read on here: GulpBin Readme

TODO:

  • [✅] Add reuse strategy
  • [⬜]] Add default components examples
  • [✅] Make a lazy loaded module
  • [⬜] Seperate Sever-only service
  • [⬜] Add PWA
  • [✅] Get rid of clonedeep in state