Client Project Template

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Contact

See Project Board for current project status.

About The Project

Built With

Usage

Contact

Installation

Prerequisites

• Node.js
• PostgreSQL
• PostGIS
• Redis
• Cmake

Setup

1. Install all prerequisites and make sure services are running. Do not proceed to step 2 until you have installed all four prerequisites.

If you are using Mac OS X, brew can install these dependencies for you. For example, to install and start Redis on a Mac:

brew install redis
brew services start redis

If you are using Windows, things are a little more complicated. You will need to install the Windows Subsystem for Linux. Then you can run:

sudo apt-get install redis-server
sudo service redis-server start

If you are using Linux, you already know how to do this.

2. Install NPM modules:

npm install

3. Set up the database:

RDS_USERNAME=$(whoami) npm run migrate

4. Seed the database (optional, slow):

RDS_USERNAME=$(whoami) npm run seed

5. Create a file named .env.local. This file overrides .env with your private data. Inside it, put:

RDS_USERNAME=<your-username>

5. Add your private credentials to .env.local.

Running

Development Mode

npm run dev

Production Mode

npm run build
npm run start