Async TS API Scaffold

Async TS API Scaffold is a clean and minimal TypeScript backend starter built with Node.js. It provides a structured foundation that helps developers quickly bootstrap APIs with best practices, modular architecture, and built-in tooling for development and testing.

🚀 Features

• Written in TypeScript for modern type-safe backend development
• Clean and extensible project structure
• Ready for REST API and async workflows
• Includes configuration, source, and tests
• Docker support for easy local setup
• ESLint + Prettier for consistent code style
• Simple scripts to aid development and workflows

📦 What You Get

The repository includes well-organized folders:

├─ config/           # Configuration files per environment  
├─ docs/             # Documentation and usage guides  
├─ src/              # Backend source code  
├─ test/             # Automated tests  
├─ .eslintrc         # Linting config  
├─ tsconfig.json     # TypeScript configuration  
├─ package.json      # Project dependencies & scripts  

🛠 Setup

Clone the project and install dependencies:

git clone https://github.com/OmO-sketch/async-ts-api-scaffold
cd async-ts-api-scaffold
npm install

⚡ Local Development

Start the API in development mode:

npm run dev

The server will automatically reload on file changes.

🧪 Testing

Run automated tests:

npm test

🚢 Docker

Build and start the server using Docker:

docker build -t async-ts-api-scaffold .
docker run -p 3000:3000 async-ts-api-scaffold

📌 Recommended Steps

1. Explore the existing configuration and folders
2. Customize src/ with your own routes and business logic
3. Add new API handlers under src/
4. Update tests and docs as your app grows