Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrickniyogitare28/node-ts-super-plate
A boilerplate for a node web api application. It's designed to work out-of-the-box.
https://github.com/patrickniyogitare28/node-ts-super-plate
boilerplate express nodejs typescript
Last synced: about 1 month ago
JSON representation
A boilerplate for a node web api application. It's designed to work out-of-the-box.
- Host: GitHub
- URL: https://github.com/patrickniyogitare28/node-ts-super-plate
- Owner: PatrickNiyogitare28
- Created: 2022-03-14T18:52:52.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-15T05:42:22.000Z (almost 3 years ago)
- Last Synced: 2024-10-15T03:53:10.811Z (3 months ago)
- Topics: boilerplate, express, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 114 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Boilerplate
A boilerplate for a node web api application. It's designed to work out-of-the-box.
## Getting started
`git clone https://github.com/PatrickNiyogitare28/node-ts-super-plate.git`
`cd node-boilerplate`
`npm install`
`npm start`
`curl localhost:8080/api/greeter?name=Bill`
- Should return: `Hello, Bill!`
### Building
`npm run build`
### Testing
`npm test`
## Running in Docker
Building a production docker image
```sh
$ docker build . -t /app-name
# docker build . -t patrickniyo/stackoverflow-auth-microservice/
```
Running the production docker image in a container
```sh
$ docker run -p : [image-name or image-id]
# docker run -p 5000:5000 patrickniyo/stackoverflow-auth-microservice/
```
## Requirements
- [Node.js®](https://nodejs.org/en/)
### Recommended
- [Visual Studio Code](https://code.visualstudio.com/)
There are included vscode specific settings included to streamline things.
[See Below](#visual-studio-code).
#### Windows-specific
- [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
Using WSL on Windows is just a smoother developer experience.
## Includes
- [TypeScript](https://www.typescriptlang.org/)
- [ESLint](https://eslint.org/)
- [typescript-ioc](https://github.com/thiagobustamante/typescript-ioc)
IoC container for typescript.
- [module-alias](https://github.com/ilearnio/module-alias)
Allows your transpiled code to actually make use of the `paths` section of your `tsconfig.json` file.
- [Mocha](https://mochajs.org/)
For testing.
- [Chai Assertion Library](https://www.chaijs.com/)
Assertion library.
## Config files
### `eslintrc.json`
Has all the rules/config for ESLint.
### `mocharc.jsonc`
Config settings for mocha when running it from the command line.
- `ts-node/register` - for compilation.
- `module-alias/register` - for path alias recognition.
### `package.json`
#### `scripts`
- `clean` - removes `dist` folder.
- `build` - runs `clean` and builds app.
- `start` - cleans, builds, and starts app.
- `test` - runs `mocha` with settings in `mocharc.jsonc`.
#### `_moduleAliases`
Needed for `module-alias` package. Should match keys in `paths` of `tsconfig.json` as such (note the lack of wildcard in `package.json`):
`package.json`
```json
{
// ...
"_moduleAliases": {
"@service": "dist/service"
// ...
}
// ...
}
```
`tsconfig.json`
```json
{
"compilerOptions": {
// ...
"paths": {
"@service/*": ["./src/service"]
// ...
}
// ...
}
}
```
### `tsconfig.json`
`include` key is for including any source files that you want VSCode to recognize.
#### `tsconfig-build.json`
Used only for build to exclude the `test` folder in compilation.
## Visual Studio Code
After cloning and prior to opening in Visual Studio Code, go ahead and run the install and build commands to prevent it barking at you.
`npm install`
`npm run build`
Once you have the folder open in Visual Studio Code, it will prompt you to download some recommended extensions... Do that...
### Recommended Extensions
#### [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
Code linter for TypeScript and JavaScript
#### [Mocha Sidebar](https://marketplace.visualstudio.com/items?itemName=maty.vscode-mocha-sidebar)
Sidebar test runner for Mocha Tests