Skip to content

calvin-kimani/snapx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Snapx

npm version License Build Status

Snapx is a modular framework built with Bun, designed to help developers build scalable and maintainable applications. It provides reusable packages for dependency injection, email services, and more.


Table of Contents


Features

  • Dependency Injection: Manage and resolve dependencies with ease.
  • Service Providers: Register and boot services in a modular way.
  • TypeScript Support: Fully typed for a better developer experience.
  • Flexible Configuration: Load providers dynamically from a configuration file.
  • Singleton, Transient, and Contextual Bindings: Register services with different lifetimes and contexts.

Packages

Snapx consists of multiple scoped packages, each serving a specific purpose:

Package Name Description npm Link README Link
@snapx/core Core functionality, including the service container and provider architecture. @snapx/core @snapx/core README

Installation

Install the required packages using your preferred package manager:

# Install the core package
bun add @snapx/core

# Install additional packages (optional)
bun add @snapx/mail

Usage

For detailed usage instructions, check the README files of each package:


Contributing

We welcome contributions from the community! Here’s how you can get involved:

  1. Fork the Repository : Fork the Snapx repository on GitHub.
  2. Clone the Repository :
git clone https://github.com/yourusername/snapx.git
cd snapx
  1. Install Dependencies :
bun install
  1. Make Changes : Create a new branch for your changes:
git checkout -b feature/your-feature-name
  1. Test Your Changes : Ensure all tests pass:
bun test
  1. Submit a Pull Request : Push your branch and open a pull request on GitHub.

License

Snapx is licensed under the MIT License. See the License file for details.


Acknowledgments

  • Built with ❤️ using Bun.
  • Inspired by modern frameworks like Laravel and NestJS.

Contact

For questions or feedback, feel free to reach out:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published