This repository is for the Express TS 6th Workshop. It aims to establish a proper backend development environment using Express, TypeScript, PostgreSQL, TypeORM . The setup includes essential tools for code quality, and formatting, providing a strong foundation for building reliable and scalable applications.
- ESLint - Linter for identifying and fixing code errors and standardizing code style
- Prettier - Code formatter for consistent styling
- Husky - Git hooks for pre-commit checks, ensuring code quality before committing
- Morgan - HTTP request logger that provides insights into request details for easier debugging and monitoring
- TypeORM - ORM for database interactions, providing a clean and scalable approach to managing database operations
- Node.js: Version 20 or higher
Ensure you have Node.js installed on your machine. You can download it here.
To set up the project locally, follow these steps:
-
Clone the repository
git clone https://github.com/oat431/sixth-ts-ex-class-template
-
Navigate to the project directory
cd sixth-ts-ex-class-template -
Install dependencies
npm install
Note: Ensure you have Node.js version 20 or above for compatibility with this project.
-
Copy .env.example and rename it to .env.dev
-
Fill up the .env.dev with your database credentials
-
Run Script to create database
npm run db-dev:create
-
Run Script to server
npm run dev
This setup ensures a well-documented and clean codebase, promoting best practices for backend development in TypeScript.
no license (yet)