README.md

Gauntlet

Gauntlet is a Typescript server template to kick-off your development fast 🔥🔥🔥

Demo site: https://gauntlet-demo.herokuapp.com

Build Status

• master
• develop

Prerequisites

• Node 8.4.0 or higher (you can try to manage your versions using nvm)

Installing

• git clone https://github.com/UltraRangers/gauntlet.git
• npm install
• Setup your database with the following
  • Create a database of your choice
  • In the config/server/ormconfig.development.json. Change the username, password and database name on your own. Each ormconfig.json is used by different environements. Change accordingly for the desired environment (dev, test, prod)

    {
        "type": "postgres",
        "host": "localhost",
        "port": 5432,
        "username": "postgres",
        "password": "postgres",
        "database": "gauntlet-development"
    }
    

• After that, you can now start your app by typing the command npm start

Running the tests

To run the test suites, type in your terminal

npm run test

Take note that you need to change your database config for test environment. See installing on how to setup database.

Built With

• Nest.js - Web framework
• TypeORM - Database Management
• Angular - Front-end

Contributing

Open for pull requests!

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository

Acknowledgments

• Hands down for the great works of pleerock and Nest.js team