Skip to content

felipeAguiarCode/node-blue-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

NODE BOILERPLATE - BLUE EDITION

Don't start a new Node project from zero!
Use this simple Nodejs boilerplate with pre-configured Typescript in a modern way.


TypeScript version Node.js version

🚀 Technologies

This code source was developed with the following items:

📦 Dependencies

  • typescript - Superset for application scale JavaScript development
  • tsx - TypeScript Execute (tsx): Enable Node.js to run TypeScript
  • tsup - Bundle your TypeScript library with no config, powered by esbuild
  • @types/node - type definitions for node

📄 Files

  • .gitignore - Ignore folders like node_modules
  • .env - Enviroment variables
  • tsconfig.json - Typescript configure Options

⚡ Scripts

  • npm run dist: Compiles TypeScript files to JavaScript in the dist directory.
  • npm run start:dev: Runs the server in development mode with environment variables loaded from the .env file.
  • npm run start:watch: Runs the server in development mode with support for automatic reload on file changes.
  • npm run start:dist: Compiles the project and runs the compiled version from the dist directory.

👨‍💻 How To Use

click in [Use this template] OR

To clone and run this application, you'll need Git, Node.js v20+ + NPM v10+ installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/felipeAguiarCode/node-blue-boilerplate

# Go into the repository
$ cd node-blue-boilerplate

# Install dependencies
$ npm install

Author


Felipe Aguiar
Linkedin

Credits

icons by Pino Lamanna