express-ts-template

Overview

This repository provides a robust starting point for building web applications using Express.js with TypeScript. It includes essential configurations, middleware setup, and project structure to kickstart your development process.

Project Database

This project is based on PostgreSQL by default. However, it's designed to be flexible, allowing you to optionally change the database to MySQL, MariaDB, SQLite, Microsoft SQL Server as needed, or Oracle Database.

Features

• Express.js: The web application framework for Node.js.
• TypeScript: A superset of JavaScript that adds optional static typing.
• ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript/TypeScript.
• Prettier: An opinionated code formatter to ensure a consistent code style.
• Sequelize: A promise-based Node.js ORM for PostgreSQL, MySQL, MariaDB, SQLite, Microsoft SQL Server and Oracle Database.
• Sequelize Auto: A tool to automatically generate models for Sequelize from an existing database.
• dotenv: A zero-dependency module that loads environment variables from a .env file into process.env.
• module-alias: Create aliases of directories and register custom module paths in Node.js.
• express-validator: An express.js middleware for validator.js.
• cors: CORS (Cross-Origin Resource Sharing) middleware for Express.js.
• PostgreSQL: A powerful, open-source object-relational database system.

Requirements

• Node.js (v18.x or Node.js LTS recommended)

Getting Started

To get started with [Project Name], follow these steps:

1. Fork the project: Click the "Fork" button in the top-right corner of the GitHub repository page. This will create a copy of the project in your GitHub account.

2. Clone your fork: Use Git to clone your forked repository to your local machine. Replace <username> with your GitHub username and <project> with the name of the project:

   git clone https://github.com/<username>/<project>.git

3. Navigate to the project directory: Change your current directory to the cloned project directory:

   cd <project>

4. Install dependencies: Use npm (Node Package Manager) to install the project's dependencies:

   npm install

   Once the dependencies are installed, you must setup databases and create table first.

5. Setup PostgreSQL database and create table: Make sure PostgreSQL is installed on your system. Then, use a PostgreSQL client such as psql or a graphical user interface like pgAdmin to connect to your PostgreSQL instance. Once connected, execute the following SQL command to create the sample_table:

   CREATE TABLE sample_table (
       id UUID NOT NULL,
       name CHARACTER VARYING(255) NOT NULL,
       lastname CHARACTER VARYING(255) NOT NULL,
       deleted_at TIMESTAMP WITHOUT TIME ZONE,
       created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
       updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
       CONSTRAINT "sample_table_pkey" PRIMARY KEY (id)
   );

6. Update configuration: Update the .env file with your own configuration for development and production environments. Here's an example configuration:

   NODE_ENV=development
   
   # Development Configuration
   PORT=4000
   
   # Development Database Configuration
   DB_HOSTNAME=127.0.0.1
   DB_PORT=5432
   DB_DIRECT=postgres
   DB_NAME=demo-express-template
   DB_USERNAME=postgres
   DB_PASSWORD=123456
   
   # Production Configuration
   PORT_PROD=6000
   
   # Production Database Configuration
   DB_HOSTNAME_PROD=127.0.0.1
   DB_PORT_PROD=5432
   DB_DIRECT_PROD=postgres
   DB_NAME_PROD=demo-express-template
   DB_USERNAME_PROD=postgres
   DB_PASSWORD_PROD=123456
   

   Ensure that to replace the placeholder values (e.g., DB_USERNAME, DB_PASSWORD, DB_NAME) with your actual database credentials.

7. Generating models from databases: Before generating models, specify the tables you want to generate models for by adding the table names to the tablesList constant in the src/utils/generate-model.ts file:

   ...
   
   const tablesList: Array<string> = [
     'sample_table',
   ];
   
   ...

8. Generate models: Once the tables are added, you can generate models using the following command:

   npm run gen-model

   This command will generate models for Sequelize from an existing database using Sequelize Auto.

   Note: Ensure that you have the required Node.js installed before running the commands. Additionally, make sure to configure the database type and tables before generating models.

9. Running the server:

   • For development server, use the following command:

     npm run dev

     This will start the Express.js server with TypeScript support. You can then access your web application at http://localhost:4000 by default. Any changes you make to the source code will automatically trigger a server restart due to hot-reloading enabled by default in development mode.

   • For production deployment, use the following command:

     npm start

     This will start the Express.js server in production mode, suitable for deploying your application to a production environment.

   Now you're all set up and ready to start working on the project!

Project Structure

app/
├── src/                    
│   ├── configs/
│   │   ├── config.dev.ts
│   │   ├── config.prod.ts
│   │   ├── config.ts
│   │   ├── databaseConnection.ts
│   │   ├── httpCodeConfig.ts
│   │   └── validRequestConfig.ts                       
│   ├── controllers/   
│   │   └── sampleController.ts      
│   ├── middlerwares/
│   │   ├── validators/
│   │   │   └── sampleValidator.ts
│   │   ├── apiError.ts
│   │   ├── asyncFunction.ts
│   │   ├── errorHandler.ts
│   │   ├── interfaceMiddleware.ts
│   │   ├── requestHandler.ts
│   │   └── validator.ts  
│   ├── models/
│   │   ├── init-models.ts
│   │   └── sampleTable.ts 
│   ├── routes/
│   │   ├── indexRouter.ts
│   │   └── sampleRouter.ts
│   ├── storages/
│   │   └── globalStorage.ts
│   ├── utils/
│   │   ├── generate-models.ts
│   │   ├── responseHandler.ts
│   │   └── utils.ts
│   ├── app.ts
│   └── server.ts              
├── .env
├── .gitignore
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
└── tsconfig.json

Dependencies

• Express
• Express-validator
• Typescript
• tsc
• Dotenv
• cors
• module-alias
• moment
• Sequelize
• pg
• pg-hstore
• sequelize-auto
• ts-node-dev

License

express-ts-template is licensed under the MIT License. Feel free to use and modify it according to your needs.