Installation & Execution

Jay Edwards edited this page Mar 28, 2018 · 7 revisions

(Co.Koa has only been tested with Linux environments. Support for other OS environments is purely speculative.)

To install a local instance of Co.Koa, you will need to install the co-koa-cli from the NPM repository. If you do not as yet have NPM and/or NodeJS installed, please visit: and follow the relevant instructions.

Installation via Global CLI

  1. To install co-koa-cli, enter npm i co-koa-cli -g into your terminal

  2. Create a directory where you would like your Co.Koa instance to live and ensure you have permission to read, write and execute within it.

  3. In terminal, navigate to your project's directory folder and type co-koa-cli --create

  4. the interface will request an NPM-friendly name for your project (npm advises names in lower case with no special characters), a repository URI and an "author" name. You can leave these names blank for now if you like, they merely update the respective fields in the project's package.json (which can be altered at a later time)

  5. Now type npm i to install Co.Koa's dependencies.

  6. Your project is installed! You'll need to wire it up with a mongoose database to finish things off. Visit for instructions.

  7. in you project, navigate to \config\config.json and set the MongoDB_URI accordingly (most likely, the default config URI will work while testing things out on a local machine).

  8. Co.Koa is installed!

(Note it is possible to install Co.Koa via an npx call within a directory, however, your local package.json will be overwritten by the CLI in the process)


  1. Ensure you have a MongoDB instance running in the background and that it's setup to start with your development environment.

  2. type npm run cokoa in the root directory of your Co.Koa project. Optionally, should you wish to run an environment other than development, simply type:

    node app.js -e <EnvironmentName>

    replacing <EnvironmentName> with the name of the desired environment.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.