👋 Need a Backend Template?

Contributor-friendly TS x ExpressJS BDD template for your next awesome open-source project.

MIT Licensed and maintained weekly. (Social preview made with Socialify )

Docs | Bugs | New Feat

📔 Table of Contents

• About
• Roadmap
• Contribute
• Acknowledgements

🌟 About

🤖 Automations

• Changelog Update
• Conventional Commit
• Unit and Feature Testing

👀 Useful Ref Inside

• ExpressJS-based and TS-friendly REST API
• Google Cloud Run Auth, Build, and Deployment

🔑 ENV

See .env.example

🧰 Getting Started

‼️ Prerequisites

• Install the latest Node JS 22 LTS Here
• Install Docker Engine (or Docker Desktop) Here
• Install pnpm as high-efficient alternative to npm Here

npm install --global pnpm@latest

⚙️ Installation

To install the full dependency

pnpm install

To install only the prod dependency

pnpm install --prod

🧪 Running Tests

To run both unit/snapeshot and feature tests

pnpm run test

To run unit/snapshot tests only

pnpm run test:unit-and-snapshot

To run feature tests only

pnpm run test:feature

🚩 Deployment

Push to main will auto-trigger the deployment script (recommend having reviewers)

.github/workflows/deploy-gcp.yml

🧭 Roadmap

👔 Functional

• MVP template setup
• REST API design template setup
• Firestore custome database CRUD template setup
• Re-factor in GOLANG waaaay in the future for better performance

🎩 Non-functional

• contributing.md setup
• CODE_OF_CONDUCT.md setup
• Issue and PR tempalte setup

❤️ Contributing

😎 Community

Contributions are always welcome! See contributing.md for ways to get started.

Made with contrib.rocks.

📜 Code of Conduct

Please read the Code of Conduct

⚠️ License

Distributed under the MIT License. See LICENSE for more information.

📲 Contact

Keming He - keminghe.career[at]gmail.com

🔆 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Typescript
• ExpressJS
• Commitizen
• Git Cliff

💎 Cool Stats

Made with Repobeats.