mirror of
https://codeberg.org/JasterV/sentences-crud.git
synced 2026-04-26 18:10:05 +00:00
second commit
This commit is contained in:
parent
9f418f84d1
commit
2fcdffd277
3 changed files with 3 additions and 47 deletions
45
README.md
45
README.md
|
|
@ -1,53 +1,10 @@
|
|||
<h1 align="center">Welcome to node ts template 👋</h1>
|
||||
<h1 align="center">Talentbait CRUD</h1>
|
||||
<p>
|
||||
<a href="https://mit-license.org/" target="_blank">
|
||||
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
> A template for typescript nodejs projects with configuration files such as
|
||||
> tsconfig & eslint.
|
||||
|
||||
## ESLint
|
||||
|
||||
Extends the airbnb javascript styleguide adding also typescript support.
|
||||
Generated with `npx eslint --init`
|
||||
|
||||
## tsconfig.json
|
||||
|
||||
This tsconfig.json comes from
|
||||
[Ben awad recommended tsconfig](https://github.com/benawad/tsconfig.json) Thanks
|
||||
Ben <3
|
||||
|
||||
## Jest
|
||||
|
||||
jest.json configured to handle *.test.ts files under the tests & src folders.
|
||||
Also we use ts-jest to run our tests without compiling typescript to javascript
|
||||
|
||||
## package.json
|
||||
|
||||
I use ts-node-dev to run my code on development mode as it is super fast (sorry
|
||||
nodemon I don't need you anymore)
|
||||
|
||||
## Prettier
|
||||
|
||||
I don't think I need prettier as this ESLint config works totally fine for me.
|
||||
If you want to make a pull request adding ESLint prettier config you are welcome
|
||||
|
||||
## .gitignore
|
||||
|
||||
.gitignore generated with gitignore.io, works fine without any further change :D
|
||||
|
||||
## Github action
|
||||
|
||||
I've just added the default nodejs github workflow as it works perfectly fine
|
||||
for simple nodejs projects (Just install dependencies, build & test)
|
||||
|
||||
## Husky
|
||||
|
||||
I love husky as it can automate jobs on any git command such as executing tests
|
||||
each time you create a commit
|
||||
|
||||
## Author
|
||||
|
||||
👤 **Victor Martinez**
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "node-ts-template",
|
||||
"name": "talentbait-test",
|
||||
"version": "0.1.0",
|
||||
"description": "A template for nodejs projects with configuration files for typescript support",
|
||||
"description": "",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
import dotenv from 'dotenv'
|
||||
import convict from 'convict'
|
||||
|
||||
dotenv.config()
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue