https://github.com/studiohyperdrive/nodejs-boilerplate

Node.js boilerplate using TypeScript, Docker, Jest, ...
https://github.com/studiohyperdrive/nodejs-boilerplate

Last synced: 8 months ago
JSON representation

Node.js boilerplate using TypeScript, Docker, Jest, ...

• Host: GitHub
• URL: https://github.com/studiohyperdrive/nodejs-boilerplate
• Owner: studiohyperdrive
• License: isc
• Created: 2019-06-17T14:06:52.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T19:54:03.000Z (over 3 years ago)
• Last Synced: 2024-04-28T06:23:23.147Z (almost 2 years ago)
• Language: TypeScript
• Size: 4.66 MB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# NODEJS-BOILERPLATE 2.0 #

[![CircleCI](https://circleci.com/gh/studiohyperdrive/nodejs-boilerplate/tree/master.svg?style=svg)](https://circleci.com/gh/studiohyperdrive/nodejs-boilerplate/tree/master)

[![Codecov badge](https://img.shields.io/codecov/c/gh/studiohyperdrive/nodejs-boilerplate.svg)](https://codecov.io/gh/studiohyperdrive/nodejs-boilerplate)

[![Greenkeeper badge](https://badges.greenkeeper.io/studiohyperdrive/nodejs-boilerplate.svg)](https://greenkeeper.io)

[![License badge](https://img.shields.io/badge/license-ISC-yellow.svg)](https://opensource.org/licenses/ISC)

Studio Hyperdrive Node.js 2.0 boilerplate

## Setup ##

### System requirements ###

* [Docker](https://docs.docker.com/engine/installation/)

* [Node.js](https://nodejs.org/en/) (LTS)

Node.js is optional and only required if you want to run the linters in your IDE. Running them inside Docker works without Node.js.

### Installation ###

Update the values (if needed) of the local config file inside `./server/.env/local.env`.

Start the Docker container:

```bash

$ docker-compose up

```

_Optional_: Install the Node.js packages locally:

```bash

$ yarn

```

## Getting started ##

Once your Docker container is running, your application is accessible on [localhost:3000](http://localhost:3000) (assuming you did not change the port in the local config file).

### Running linter ###

Running TSlint inside Docker:

```bash

$ docker-compose exec server yarn run lint

```

### Running tests ###

Running tests inside Docker:

```bash

$ docker-compose exec server yarn run test

```

## Bugs ##

In case of bugs, issues, questions, ... check the [issues](https://github.com/studiohyperdrive/nodejs-boilerplate/issues) on Github.

## Contributions ##

Contributions through pull requests are more than welcome. Make sure you respect the current tools, guidelines and flow to get your improved version accepted.

## License ##

See [LICENSE](LICENSE).