Skip to content

NanoService is an open-source framework that enables developers to build lightweight, modular, and scalable backend applications using nanoservices.

License

Notifications You must be signed in to change notification settings

AasthathecoderX/nanoservice-ts

 
 

Repository files navigation

GitHub Repo stars GitHub forks GitHub Issues or Pull Requests GitHub License GitHub contributors Discord


Logo

Nanoservice.ts

Nanoservice-ts is an open-source framework that enables developers to build lightweight, modular, and scalable backend applications using nanoservices.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Running Workflows
  4. Contributing
  5. License
  6. Contact

About The Project

nanoservice-ts is an open-source framework designed to simplify backend development by enabling developers to implement the nanoservices architecture effortlessly. Built with TypeScript, this framework helps you create lightweight, modular, and scalable backend systems that adhere to the Single Responsibility Principle (SRP).

By combining an intuitive API, programmatic workflow orchestration, and powerful tooling, nanoservice-ts allows you to focus on writing business logic while abstracting the complexities of infrastructure, scaling, and resource management.

Key Highlights

  • Nanoservices Architecture: Divide backend logic into reusable, single-responsibility units that are easy to manage, scale, and debug.
  • Developer-Friendly Tools: Use TypeScript-powered APIs, templates, and a CLI for quick project setup and workflow creation.
  • Efficient and Scalable: Built to support dynamic workflows with containerized execution and independent scalability for each nanoservice.
  • Community-Driven: Collaborate, share, and benefit from a growing library of community-created nodes and workflows.

Why nanoservice-ts?

Modern backend development often suffers from over-engineered solutions, resource inefficiencies, and complex architectures. nanoservice-ts addresses these pain points by offering:

  • Modular Design: Reuse components across projects, reducing redundancy and improving productivity.
  • Simplified Scaling: Focus on scaling individual nanoservices based on real-time demands, optimizing resource usage.
  • Flexibility: Build workflows programmatically or using pre-built templates for common tasks like HTTP APIs, event processing, and scheduled jobs.

With nanoservice-ts, backend development becomes modular, predictable, and future-proof, making it ideal for both small projects and large-scale systems.

(back to top)

Getting Started

To start developing your project, simply run:

  npx nanoctl@latest create project

And follow the instructions of the CLI

For more information and examples, visit Getting Started

(back to top)

Creating Nodes & Workflows

  • Node is a small functioning unit designed to perform a specific task within a workflow
  • Workflow is a collection of nodes group together in a certain sequence to create a piece of business logic that starts with a trigger
  • Trigger is an event or condition that starts the execution of a workflow

For a step-by-step example of how to use nodes, workflows, and triggers, visit Quickstart

(back to top)

Running Workflows

To run the created workflow locally:

  1. Start the runner via npm run dev
  2. Use tools like POSTMAN, curl, or any HTTP client to test workflows at http://localhost:4000/{workflow-name}

For more examples, please refer to the Executing Workflows

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache License 2.0. See LICENSE.txt for more information.

(back to top)

Contact

Discord: Nanoservice

X: @nanoservice_ts

Reddit: r/nanoservice

Project Link: https://github.com/deskree-inc/nanoservice-ts

(back to top)

Acknowledgments

Some awesome tools used in the project:

(back to top)

About

NanoService is an open-source framework that enables developers to build lightweight, modular, and scalable backend applications using nanoservices.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 70.3%
  • PLpgSQL 21.0%
  • JavaScript 4.9%
  • HTML 3.0%
  • Other 0.8%