An open API service indexing awesome lists of open source software.

https://github.com/muneebhashone/typescript-backend-toolkit-web

A powerful backend toolkit designed for scalability and flexibility. Built with modern technologies and best practices, it's the perfect starting point for your next backend project.
https://github.com/muneebhashone/typescript-backend-toolkit-web

Last synced: 5 days ago
JSON representation

A powerful backend toolkit designed for scalability and flexibility. Built with modern technologies and best practices, it's the perfect starting point for your next backend project.

Awesome Lists containing this project

README

          

# TypeScript Backend Toolkit

A powerful backend toolkit designed for scalability and flexibility. Built with modern technologies and best practices, it's the perfect starting point for your next backend project.

## Features

- ๐Ÿ“š **OpenAPI Docs** - Automatically generated Swagger docs through MagicRouter API and Zod
- ๐Ÿ”’ **Auth Module** - Includes Google Sign-In support for easy authentication
- ๐Ÿ“ค **File Upload** - Handles file uploads with Multer and Amazon S3
- โœ… **Data Validation** - Zod for validation and serialization of data
- ๐Ÿ“ง **Type-safe Emails** - Emails managed using React Email and Mailgun
- โšก **Background Jobs** - Powered by BullMQ with Redis for handling background jobs

## Prerequisites

Before you begin, ensure you have the following installed:

- ๐Ÿ“ฆ Docker + Docker Compose - Required for running Redis and other services
- ๐Ÿ“ฅ PNPM - Fast, disk space efficient package manager
- ๐Ÿ–ฅ๏ธ Node.js 20+ (LTS) - Latest LTS version recommended for best performance

## Quick Start

```bash
# Clone the repository
git clone https://github.com/muneebhashone/typescript-backend-toolkit.git

# Navigate to project directory
cd typescript-backend-toolkit

# Start Docker services
docker compose up -d

# Install dependencies and start development server
pnpm i && pnpm run dev
```

## Roadmap

- ๐Ÿ”„ Socket.io Support with Redis adapter
- ๐Ÿ“ฌ Notification Infrastructure via FCM and Novu
- ๐Ÿ› ๏ธ Ansible Playbook for server configuration
- โ˜๏ธ AWS CDK Support for infrastructure
- ๐Ÿ“ฆ Monorepo Support with Turborepo
- ฮป AWS Lambda Support
- ๐ŸŒ Cloudflare Workers Support
- ๐Ÿ—„๏ธ Postgres Support with Drizzle
- ๐Ÿณ Containerization with Docker
- โš“ Kubernetes Support
- ๐Ÿ”„ CI/CD with GitHub Actions
- ๐Ÿงช Testing with Jest

## Contributing

Feel free to contribute to this project! Pull requests are welcome.

## License

Licensed under MIT

---

Made with โค๏ธ for the TypeScript community