eltonlazzarin / node-typescript-structure

Simple TypeScript structure to use in Node projects

Simple TypeScript structure to use in Node projects

About The Project   |    Technologies   |    Getting Started   |    How To Contribute   |    License

👨🏻‍💻 About the project

Simple TypeScript structure to use in future Node + TypeScript projects

🚀 Technologies

Technologies that I used to develop this frontend app

• NodeJS
• TypeScript
• Express
• ESLint
• Jest
• TS-Jest
• TS-Node-Dev
• TSConfig-Paths
• VS Code with EditorConfig and Prettier RC

💻 Getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/node-typescript-structure.git

$ cd node-typescript-structure

Follow the steps below

# Install the dependencies
$ yarn

# Run the web app
$ yarn dev

🤔 How to contribute

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/node-typescript-structure.git

$ cd node-typescript-structure

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 License

This project is under the MIT license. See the LICENSE for more information.