NodeTsFam NodeJs Framework

Description 📦

NodeTsFam is an acronym for NodeJs Typescript Framework

The "NodeTsFem" project provides a custom setup for Node.js development, designed to make it easy for developers to bootstrap a new project. It uses TypeScript for static typing and includes pre-configured tools and scripts for building, testing, and running the application.

This project aims to reduce the time and effort required to start a new Node.js project by providing a ready-to-use environment that follows current best practices. It's perfect for developers who want to focus on writing their application code, without having to worry about setting up the development environment from scratch.

Whether you're a seasoned Node.js developer or just getting started, "NodeTsFem" can help you kickstart your next project quickly and efficiently.

Technologies used

1. Express
2. Typescript
3. Docker
4. Jest
5. Mongo DB
6. Sqlite3 DB

Processes

1. Eslint
2. Prettier
3. Git Hooks Husky
4. Git Action

Database used

Out of the box, we support MongoDB(using Moongose as the ODM) and SQLite3(using Sequelize as the ORM). But you can plugin your own db here

Architecture used(MVC)

This project uses the MVC software design pattern

Scripts

Ensure you are using the specified node version If you have nvm, run the below command to select the latest node version:

nvm use

Dependencies installation

yarn

Development server

yarn run dev

Open http://localhost:8080 with your browser to see the result.

If the server startup was successful, you should see the below view

If you try accessing an un-existing route, you will see an API response like below

Production build

yarn run build

Run unit tests

yarn run test

Run unit tests coverage

yarn run test:coverage

Lint errors

yarn run lint

Format errors

yarn run format

Env variable sample you could just use

create a file in the root folder called .env and paste the below data

NODETSFAM_APP_NAME="NodeTsFam"
NODETSFAM_SERVER_PORT=8080
NODETSFAM_SERVER_URL="https://localhost:8080"

The below `env vars` are optional

NODETSFAM_MONGO_DB_URI="If you chose to opt-in for mongo db,then paste in your db_uri"

NODETSFAM_CLIENT_URL="if a website will be using your server, then paste in the URL e.g: <http://localhost:4000>"

NODETSFAM_CLIENT_PORT="if a website will be using your server, then paste in the PORT e.g: 4000"

Real life usage of this project

Youtube Video coming soon