https://github.com/jvictorfarias/boilerplate-nodejs-typescript
:file_folder: A boilerplate for NodeJS + Express + TypeScript APIs inspired by AdonisJS
https://github.com/jvictorfarias/boilerplate-nodejs-typescript
Last synced: 7 months ago
JSON representation
:file_folder: A boilerplate for NodeJS + Express + TypeScript APIs inspired by AdonisJS
- Host: GitHub
- URL: https://github.com/jvictorfarias/boilerplate-nodejs-typescript
- Owner: jvictorfarias
- License: mit
- Created: 2020-04-19T14:20:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T17:15:57.000Z (over 2 years ago)
- Last Synced: 2025-01-20T07:43:41.028Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 853 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## 🗄️ NodeJS, TypeScript and Express template
This template is made for building new APIs with these technologies and includes:
- TypeScript runtime configuration
- ESLint preferences(AirBnB style)
- Prettier config for better linting
- Project folder tree based on standards
- Pre-configured ORM(TypeORM) with User model
- JWT authentication
- Routes template
- Upload file configuration
## 📥️ Dependencies
- bcryptjs
- dotenv
- express
- express-async-errors
- jsonwebtoken
- multer
- ora
- reflect-metadata
- typeorm
- uuidv4
## 📑 How to install
Clone this repository and open the project, next install the dependencies:
```bash
yarn install
```
Write your personal configurations on a ***.env*** file based on ***.env.example***, create your database and run the migrations:
```bash
yarn typeorm migration:run
```
Now you are ready to code!
## 📖 License
See the LICENSE file for more details.
Made with ❤️ by Joao Victor Farias