Node Project Template

Public Template Project

Read this in other languages: English.

Contents

1. Short description
2. Long description
3. Project roadmap
4. Getting started
5. Projects using Template
6. Useful Commands
7. Built with
8. Contributing
9. Versioning
10. Authors
11. License
12. Acknowledgments

Short description

Base Template for any Node.js Application.

What's the problem?

It can take minutes, to sometimes hours to setup the Base Project, get your Process Manager Setup, Figure out your Docker Support, get your Development Tools setup, maybe even setup your Readme with all the commands you need and copy/paste them into the terminal.

How can technology help?

It has a simple, base structure to build off of for any Node.js Application Development. It comes with a complete Makefile with docker-compose and docker support along with pm2 deployment support.

The idea

I got sick and tired of setting up Node.js Micro Service projects, and after doing it 1000 times I just said.. Template time, and here we are.

Long description

More detail is available here

Project roadmap

RoadMap

Getting started

Prerequisites

1. Docker Installed
2. If you are a Windows User please Install Windows SubSystem Linux (Ubuntu)
3. 1. Make sure you have make installed. and WSL2 along with patch kernal & Docker-edge
4. Install Node.js
5. 1. Install PM2 Globally
6. Rename the example.env file to .env and fill in the Information requested as well as put your Variables there.

Installing

Just Git Pull the Repo, or download a Zip of it.

Projects using Template

Currently working on utilizing this in a few Projects will List them here, once they are ready.

Useful Commands

1. make npm
2. 1. Installs Project Deps utilizing NPM
3. make yarn
4. 1. Installs Project Deps utilizing Yarn
5. make start
6. 1. Starts Project Locally with what the NODE_ENV has set. production, staging, or development
7. make stop
8. 1. Stops the Project Locally
9. make build
10. 1. Builds the Project into a docker container.
11. make up
12. 1. Brings the Docker Container up for Testing utilizing Docker Compose
13. make logs
14. 1. Allows you to see all the Logs for a Current Project
15. make down
16. 1. Brings the Docker Container down
17. make console
18. 1. Opens a console into the Container for the Project
19. make pm2deploy
20. 1. Deploy's the Project too whatever server it is set too, with settings based on NODE_ENV
21. make pm2setup
22. 1. This will Setup the Server the Project is being Deployed too.
23. make pm2update
24. 1. Update a Project on the Deployment Servers.

Built with

• Node.js - Base of the Project
• Docker - Easy Local Testing
• PM2 - Fastest way to keep a process for testing
• GIT - Doing the Storage and Updating WOOT
• Make - I couldn't live without you, I want you too know <3

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Randolph Bioblaze Payne Aarseth - Initial work - Bioblaze

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2 License - see the LICENSE file for details

Acknowledgments

• Based on Billie Thompson's README template.
• Built off of Code and Response Sample Project.