https://github.com/stephnr/super-node-starter

an improved starter template project I use for building backend servers in NodeJS
https://github.com/stephnr/super-node-starter

node nodejs starter-template template typescript yarn

Last synced: about 1 month ago
JSON representation

an improved starter template project I use for building backend servers in NodeJS

• Host: GitHub
• URL: https://github.com/stephnr/super-node-starter
• Owner: stephnr
• License: gpl-3.0
• Created: 2015-12-21T03:56:36.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-15T02:33:07.000Z (almost 8 years ago)
• Last Synced: 2024-10-25T08:35:28.130Z (3 months ago)
• Topics: node, nodejs, starter-template, template, typescript, yarn
• Language: TypeScript
• Homepage:
• Size: 1.03 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Super Node Starter

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/stephn-r/super-node-starter)

### Details

A complete NodeJS server starter template. This template is designed to give any NodeJS project an extreme running start that includes some of the most common features vital to the Client/Server relationship model while providing various other tools, and resources for quickly building out any part of the server development stack.

Please refer to the [CONTRIBUTING.md](https://github.com/stephn-r/super-node-starter/blob/master/CONTRIBUTING.md) doc for any questions, concerns, or suggestions

#### Running For Development

**a. Install dependencies**

```sh

yarn install

```

**b. Provide a `.env` file (copy the template) and provide you own values**

```sh

cp .env.example .env

```

Create a local relational database in MySQL/Postgres/etc (see sequelize for supported dialects) and fill out the env values to connect there.

**c. Run the database migrations**

```sh

sequelize db:migrate

```

Note: You may want to install an editor plugin to automatically do this for you on file save, like atom-typescript

**d. Run the app!**

```sh

npm start

```

#### Local Docker Deployment

Build using Docker Compose by executing the following command:

```sh

npm run deploy

```