Skip to content

Latest commit

 

History

History
executable file
·
59 lines (39 loc) · 1.31 KB

README.md

File metadata and controls

executable file
·
59 lines (39 loc) · 1.31 KB

Guido Backend

Build status GitHub repository Documentation

Backend for the Guido application. You can include the library in your project or start it as a standalone API server.

Getting started

Requirements

  • Node 6
  • npm 4
  • PostgreSQL

Installation

# Run as a simple user
git clone https://github.com/o10if/guido-backend.git
cd guido-backend
npm install

Configuration

You need to provide the DATABASE_URL environment variable encoding the database connection information.

  • Linux:

    export DATABASE_URL="postgres://user:password@host:port/dbname"
  • Windows:

    setx DATABASE_URL "postgres://user:password@host:port/dbname"

You can also set the PORT environment variable to change the port used by the API.

Run

# Run as a simple user
npm start

Documentation

See the documentation website.

License

MIT License