Skip to content

nhannguyendevjs/node-mongo-starter-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

node-mongo-starter-kit

Node mongo starter kit

Author

Nhan Nguyen

License

Copyright Β© 2024, Nhan Nguyen.

Released under the MIT License.

Things We Code With

Git NPM HTML5 CSS3 SASS JavaScript TypeScript Angular Nodejs MongoDB Postgres Vite Docker

Docker

Installation

You can download and install Docker on https://docs.docker.com/desktop/install/windows-install/

Network

docker network create node-mongo-network

Ubuntu

docker run --name node-mongo-ubuntu --network node-mongo-network -p 80:8080 -p 443:8443 -p 22:22 -itd ubuntu:latest

MongoDB

docker run -d --network node-mongo-network --name node-mongo -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=admin -e MONGO_INITDB_ROOT_PASSWORD=admin mongo:latest

docker exec -it node-mongo mongosh

URI

mongodb://admin:admin@localhost:27017/

Redis

docker run -d --network node-mongo-network --name node-mongo-redis -p 6379:6379 redis:latest

Coding Naming Conventions

βž– PascalCase πŸ‘‰ Classes and Methods

βž– camelCase πŸ‘‰ variable and function names

βž– snake_case πŸ‘‰ file names and variable identifiers

βž– kebab-case πŸ‘‰ HTML attributes and CSS classes

βž– UPPERCASE πŸ‘‰ CONSTANTS and ENUMERATIONS

βž– UPPER_SNAKE_CASE πŸ‘‰ CONSTANTS and ENVIRONMENT_VARIABLES

Git Branch Naming Convention

Code Flow Branches

βž– Development (dev)

All new features and bug fixes should be brought to the development branch.

βž– QA/Test (test)

Contains all codes ready for QA testing.

βž– Staging (staging, Optional)

It contains tested features that the stakeholders wanted to be available either for a demo or a proposal before elevating into production.

βž– Master (master)

The production branch, if the repository is published, is the default branch being presented.

Temporary Branches

βž– Feature

Any code changes for a new module or use case should be done on a feature branch. This branch is created based on the current development branch. When all changes are Done, a Pull Request/Merge Request is needed to put all of these to the development branch.

Examples

feature/AZURE-1234

feature/AZURE-5678

βž– Bug Fix

If the code changes made from the feature branch were rejected after a release, sprint or demo, any necessary fixes after that should be done on the bugfix branch.

Examples

bugfix/AZURE-1234

bugfix/AZURE-5678

βž– Hot Fix

If there is a need to fix a blocker, do a temporary patch, or apply a critical framework or configuration change that should be handled immediately, it should be created as a Hotfix. It does not follow the scheduled integration of code and could be merged directly to the production branch and then into the development branch later.

Examples

hotfix/disable-endpoint-zero-day-exploit

hotfix/increase-scaling-threshold

βž– Experimental

Any new feature or idea that is not part of a release or a sprint. A branch for playing around.

Examples

experimental/dark-theme-support

βž– Build

A branch specifically for creating specific build artifacts or for doing code coverage runs.

Examples

build/azure-metric

βž– Release

A branch for tagging a specific release version.

Examples

release/app-1.0.0

βž– Merging

A temporary branch for resolving merge conflicts, usually between the latest development and a feature or Hotfix branch. This can also be used if two branches of a feature being worked on by multiple developers need to be merged, verified, and finalized.

Examples

merge/dev_lombok-refactoring

merge/combined-device-support

MongoDB Naming Conventions

Use clear, descriptive names. Use camelCase for multi-word names. Avoid using MongoDB reserved words.

Visual Studio Extensions

  • Prettier - Code formatter
  • SonarLint
  • Code Spell Checker

Issues

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published