Skip to content

Commit 9e3ed5f

Browse files
committed
🆕 add codes to scaffolding
1 parent 95dc7e4 commit 9e3ed5f

17 files changed

+3313
-2118
lines changed

.editorconfig

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true

.env.defaults

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
NODE_ENV=development

.env.schema

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
NODE_ENV=

.huskyrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"hooks": {
3+
"pre-commit": "npm run lint",
4+
"pre-push": "npm run test"
5+
}
6+
}

.nycrc

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"extends": "@istanbuljs/nyc-config-typescript",
3+
"all": true,
4+
"check-coverage": true,
5+
"extension": [
6+
".ts"
7+
],
8+
"include": [
9+
"src/**/*.ts"
10+
],
11+
"exclude": [
12+
"coverage/**",
13+
"specs/**"
14+
],
15+
"reporter": [
16+
"html"
17+
]
18+
}

CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Band-aid
2+
3+
:bulb::tada: First off, thanks for taking the time to contribute! :tada::bulb:
4+
5+
## Table Of Contents
6+
7+
[Styleguides](#styleguides)
8+
9+
* [Branch names](#branch-names)
10+
* [Git Commit Messages](#git-commit-messages)
11+
* [Documentation Styleguide](#documentation-styleguide)
12+
13+
## Styleguides
14+
15+
### Branch names
16+
17+
* The branch name all starts with [fix, add, remove, refactor]
18+
19+
### Git Commit Messages
20+
21+
* Limit the first line to 72 characters or less
22+
* Use the present tense ("Add feature" not "Added feature")
23+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
24+
* Reference issues and pull requests liberally after the first line
25+
* Consider starting the commit message with an applicable emoji
26+
* :new: `:new:` when add code or file(s)
27+
* :poop: `:poop:` when add code or file(s) that needs refactor later
28+
* :art: `:art:` when improving the format/structure of the code
29+
* :rocket: `:rocket:` when improving performance
30+
* :book: `:book:` when writing docs
31+
* :abc: `:abc:` when renamining or fixing syntax errors
32+
* :bug: `:bug:` when fixing a bug
33+
* :fire: `:fire:` when removing code or file(s)
34+
* :green_heart: `:green_heart:` when fixing the CI build
35+
* :traffic_light: `:traffic_light:` when adding tests
36+
* :arrow_up: `:arrow_up:` when upgrading dependencies
37+
* :arrow_down: `:arrow_down:` when downgrading dependencies
38+
* :x: `:x:` when removing dependencies
39+
* :shirt: `:shirt:` when improving or fixing linters
40+
41+
### Documentation Styleguide
42+
43+
* Use [CHANGELOG.md](CHANGELOG.md) to doc your changes.

Dockerfile

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
FROM node:12-alpine
2+
3+
RUN mkdir /api
4+
5+
COPY package.json /api/package.json
6+
COPY package-lock.json /api/package-lock.json
7+
8+
WORKDIR /api
9+
10+
RUN npm install
11+
12+
COPY . .
13+
14+
RUN npm run build
15+
16+
CMD node build/server.js

README.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1-
# boilerplate
1+
# :skull: Scaffolding node typescript
2+
3+
## Project setup
4+
5+
```bash
6+
git clone https://github.com/codermarcos/scaffolding-node-typescript.git
7+
8+
cd scaffolding-node-typescript
9+
10+
npm install
11+
```
12+
13+
### Compiles and hot-reloads with linter server for development
14+
15+
```bash
16+
npm start
17+
```
18+
19+
### Run coverage
20+
21+
```bash
22+
npm run coverage
23+
```
24+
25+
### Run tests for development
26+
27+
```bash
28+
npm run test:tdd
29+
```
30+
31+
### Run tests
32+
33+
```bash
34+
npm run test
35+
```
36+
37+
### Run linter
38+
39+
```bash
40+
npm run lint
41+
```
42+
43+
### Dev Team
44+
45+
This project exists thanks to all these people.
46+
47+
![Marcos](https://avatars3.githubusercontent.com/u/12430365?s=460&u=12d4a3464b5a736061dbd0ccca8f57f6d08902d7&v=4)

0 commit comments

Comments
 (0)