https://github.com/the-moebius/node-starter

Node.js service starter project
https://github.com/the-moebius/node-starter

Last synced: 5 days ago
JSON representation

Node.js service starter project

• Host: GitHub
• URL: https://github.com/the-moebius/node-starter
• Owner: the-moebius
• License: mit
• Created: 2023-03-18T14:51:14.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-01T13:35:10.000Z (about 1 year ago)
• Last Synced: 2023-11-02T11:27:30.976Z (about 1 year ago)
• Language: TypeScript
• Size: 335 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Node.js service starter project

> Replace the content of this file with your own README.

## Replacement keys

Replace the following strings across the entire project

with your own:

- `node-starter` — name of the project

Then, remove this section.

## Environment variables

This project uses dotenv for development configuration.

Use the provided [.env.dist](./.env.dist) file to initialize

your local configuration:

```shell

cp ./.env.dist ./.env

```

## Docker Compose

This project uses [Docker Compose](https://docs.docker.com/compose/)

to provision development dependencies, like databases, caching layers

and other services.

Make sure to start services from

[dev/docker-compose.yml](./dev/docker-compose.yml) file,

before running the application locally.

## Running from IDE

You can run server/commands locally from your IDE:

- Set Node.js argument:

  `--loader ts-node/esm`

- Set environment variable:

  `TS_NODE_PROJECT=tsconfig.app.json`

## License (MIT)

@TODO — DON'T FORGET TO UPDATE THE LICENSE!

Copyright © 2021—2023 Moebius, Slava Fomin II

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.