about_repositories.md

Description of repositories

The archiejs project currently has about 7 repositories (excluding this one). Below is a description of the repositories.

Demo apps

1. Demo desktop app - basic

   A commandline app for converting scanned reciepts into text - using google cloud services. NOTE: setting up permissions on GCM should take 30 mins (or so) if you follow the steps.

2. Demo web app - microservices

   A demo webapp, where one of the module is loaded as a microservice. This also demos the use of enhancers.

Tools and boilerplate

1. Archiejs commandline generator

   A yo generator for archiejs.

2. Boilerplate for webapp

   Boilerplate code for archiejs webapp - archiejs, express, mongo, redis.

Repositories for core developers

1. Archiejs core module

   The core archiejs module.

2. Archiejs kue enhancer

   An enhancer which converts a module into a microservice accessible via redis pub-sub (kue).

3. Archiejs mongodb enhancer

   An enhancer which converts db tables into archiejs services, so that other modules can specifiy their dependency on particular db tables in a more fine grained manner.