Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dreamsparkx/node-ts-starter

NodeJS Typescript Boilerplate
https://github.com/dreamsparkx/node-ts-starter

api express express-js expressjs mongodb node node-js nodejs typescript

Last synced: 9 days ago
JSON representation

NodeJS Typescript Boilerplate

Host: GitHub
URL: https://github.com/dreamsparkx/node-ts-starter
Owner: dreamsparkx
License: mit
Created: 2022-01-26T16:54:31.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-10-29T14:02:34.000Z (22 days ago)
Last Synced: 2024-10-29T17:12:25.776Z (22 days ago)
Topics: api, express, express-js, expressjs, mongodb, node, node-js, nodejs, typescript
Language: TypeScript
Homepage:
Size: 3.78 MB
Stars: 2
Watchers: 2
Forks: 3
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # node-ts-starter

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdreamsparkx%2Fnode-ts-starter.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdreamsparkx%2Fnode-ts-starter?ref=badge_shield)

[![Coverage Status](https://coveralls.io/repos/github/dreamsparkx/node-ts-starter/badge.svg?branch=master)](https://coveralls.io/github/dreamsparkx/node-ts-starter?branch=master)

[![Commit activity](https://img.shields.io/github/commit-activity/y/dreamsparkx/node-ts-starter?style=flat-square)](https://github.com/dreamsparkx/node-ts-starter/commits/)

![main.yml workflow](https://github.com/dreamsparkx/node-ts-starter/actions/workflows/main.yml/badge.svg)

The main purpose of this repository is to show a working Node.js API Server + front-end project and workflow for writing Node code in TypeScript.

# Pre-reqs

To build and run this app locally you will need a few things:

- Install Node.js

- Install MongoDB

# Getting Started

Clone the repository

```

git clone https://github.com/dreamsparkx/node-ts-starter 

```

Install dependencies

```

cd 

npm install

```

Configure and start MongoDB

```

mongod

# on macOS 10.15 or above the db directory is under home directory

mongod --dbpath ~/data/db

```

Build and run the project

```

npm run build

npm start

```

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdreamsparkx%2Fnode-ts-starter.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdreamsparkx%2Fnode-ts-starter?ref=badge_large)