https://github.com/gabrielmaialva33/node-ts-app
A complete Node.js project template using TypeScript and following general best practices.
https://github.com/gabrielmaialva33/node-ts-app
adonis-config config eslint nodejs prettier template typescript
Last synced: 8 months ago
JSON representation
A complete Node.js project template using TypeScript and following general best practices.
- Host: GitHub
- URL: https://github.com/gabrielmaialva33/node-ts-app
- Owner: gabrielmaialva33
- License: mit
- Created: 2022-06-12T12:02:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T23:42:31.000Z (about 1 year ago)
- Last Synced: 2025-04-23T00:04:00.625Z (about 1 year ago)
- Topics: adonis-config, config, eslint, nodejs, prettier, template, typescript
- Language: TypeScript
- Homepage:
- Size: 462 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A template for Node.js
A complete Node.js project template using TypeScript
About |
Technologies |
Tools |
Installation |
License
## :bookmark: About
**Node Typescript App** A complete Node.js project template using TypeScript and following general best practices.
## :computer: Technologies
- **[Typescript](https://www.typescriptlang.org/)**
- **[Node.js](https://nodejs.org/)**
- **[Eslint](https://eslint.org/)**
- **[Prettier](https://prettier.io/)**
## :wrench: Tools
- **[Visual Studio Code](https://code.visualstudio.com/)**
- **[WebStorm](https://www.jetbrains.com/webstorm/)**
## :package: Installation
### :heavy_check_mark: **Prerequisites**
The following software must be installed:
- **[Node.js](https://nodejs.org/en/)**
- **[Git](https://git-scm.com/)**
- **[NPM](https://www.npmjs.com/)** or **[Yarn](https://yarnpkg.com/)**
- **[Docker](https://www.docker.com/)**
- **[Docker Compose](https://docs.docker.com/compose/)**
### :arrow_down: **Cloning the repository**
```sh
$ git clone https://github.com/gabrielmaialva33/node-ts-app.git
```
### :arrow_forward: **Running the application**
- :package: API
```sh
$ cd node-ts-app
# install dependencies
$ yarn # or npm install
# run the application
$ yarn start:dev # or yarn start
```
### :writing_hand: **Author**
| [](https://github.com/gabrielmaialva33) |
| ----------------------------------------------------------------------------------------------------------------- |
| [Gabriel Maia](https://github.com/gabrielmaialva33) |
## License
[MIT License](LICENSE)
© 2017-present Maia