thebinarypenguin / guinea-pig-server

A Sample application for testing various cloud platforms

0 stars 0 forks source link

readme

Technically it's supposed to be a hamster sitting in a little airplane.
From The Simpsons episode 'Duffless'

Guinea Pig (server)

A sample application for testing various cloud platforms

Features

A "hello world" endpoint to test that the service is running.
A stateful counter to test that the database connection is working.
A way to manually crash the service to test how the platform handles app crashes.
A "health check" route designed to be constantly "pinged" to determine if the service is running.

Installation

Create an environment file.
```
cp example.env .env
```
Replace the sample content with your database credentials and other configuration options. You will need one database for the application and a second database for the tests.
Install dependencies.
```
npm install
```
Migrate the application database.
```
npm run migrate-up
```
Seed the application database.
```
npm run seed
```
Start the application.
```
npm start
```