api-compassion

api-echo-church

REST API endpoints for Rock RMS backend.

Getting started

First, clone this repository.

If this fails, check to make sure you have added your SSH public key to GitHub.

Note: This is a private repository. Therefore, it is not recommended to use the HTTPS URL to clone this repository. If you use HTTPS to clone, you will be required to enter your GitHub username and password every time you run a Git command that involves syncing with GitHub.

Prerequisites

Before getting started, you will need to be running a POSIX compliant operating system. Most UNIX and Linux machines will be POSIX compliant.

Note for Windows 10: If you’re on Windows, you will need Windows Subsystem for Linux (WSL). See Windows Subsystem for Linux Installation Guide for Windows 10 for more information on how to install Linux on your Windows PC.

Note for macOS: As of OS X 10.9, you will need to install Xcode command line tools in order to have development toolchain like Git. To install Xcode command line tools, type:

xcode-select --install

Alternatively, you may also download full version of Xcode from the macOS App Store here.

Node.js installation

To get started, you will need Node.js. This documentation will utilize Node Version Manager (nvm) to install Node.js on your system as it is the most convenient way to have consistent Node.js development environment.

If you don’t already have nvm installed, follow the installation instructions.

Let’s install Node.js 12.10:

$ nvm install 12.10
Downloading and installing node v12.10.0...
Downloading https://nodejs.org/dist/v12.10.0/node-v12.10.0-darwin-x64.tar.xz...
######################################################################## 100.0%
Computing checksum with sha256sum
Checksums matched!
Now using node v12.10.0 (npm v6.11.3)

Install dependencies

In the project directory root, run:

npm install

Set up environment variables

Copy .env.example to .env:

cp .env.example .env

Open .env and fill in the database connection configuration.

You should now be ready to run a dev server in your local environment!

Running development server

In production mode, you will normally be required to compile before running the API server. However, this can get tedious quickly. This project provides a convenience script to start the server in development mode:

npm run dev