GitHub Install

The CityZen client is built using Vue.js. The server backend is Node.js with a SQL Lite database.

Tip CityZen requires a fairly recent version of both npm and Node.js. To install both go here: Get NPM
For reference when these docs were written we were using version 12.18.1 of Node.js and version 6.14.5 of npm

Install using GitHub

The CityZen-Server project page on GitHub: CityZen-Server

There are two different methods to install CityZen from GithHub

The first method is to clone the project. Note you need to have the GIT CLI installed to use this method.


To install CityZen-Server go to the directory you want to use and type:

git clone https://github.com/codeforlansing/cityzen-server.git

Then go to the directory you chose and type:

npm install

To launch the server type:

npm start


The CityZen-Client page on Github: CityZen-Client

Here are directions to install the CityZen-Client from GitHub.

git clone https://github.com/codeforlansing/cityzen-client-vue.git

Then go to the directory you chose and type:

npm install

To start the client once it is successfully installed type and you're in the client directory:

npm start serve

The second method for installing is to download the zip files for both server and client. To do that on the respective GitHub repository sites, hit the green clone or download button and choose download and then download zip

TIP If you need a local development web server CityZen recommends http-server