Sodacore
Sodacore is a bun-powered framework for building server-side applications utilising the lighting fast Bun runtime.
The @sodacore/cli package provides CLI functionality for the framework, allowing you to define CLI commands that can be called upon from the terminal.
Explore the docs ยป
Report Bug
โฌ
Request Feature
  
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)
- [Notice](#notice)
## About The Project
Sodacore is a [Bun](https://bun.sh) powered framework for writing server-side applications in record time. The framework follows a controller pattern, utilising plugins as the core means for extending the framework.
Sodacore comes with a lot of great features:
- ๐ง Autowiring by default
- ๐งฉ Dependency injection
- ๐งช Plugin system
- ๐ฆ Core maintained plugins, i.e. http, ws, di, etc.
- ๐ Clean and simple logger that can be extended.
- ๐ Built-in documentation
- ๐งต Easy Threading and worker support.
- ๐ฅ๏ธ CLI for tooling...soon...
The framework is constantly being worked on and improved so suggestions and features are highly appreciated.
> As of right now, we use TypeScript's legacy decorators, this is mostly because the current stage 3 decorators are very limited in functionality (i.e. param decorators) so once they drop support for legacy decorators we will switch, but until then this framework will continue to use them.
### Built With
This project was built with the following technologies:
- [Bun](https://bun.sh/)
- [TypeScript](https://www.typescriptlang.org/)
## Getting Started
Sodacore is a collection of packages, this is one of those packages, to get started head over to the documentation site [here](https://sodacore.dev) to get started.
## Roadmap
Our roadmap is published on our documentation site [here](https://sodacore.dev/about/roadmap.html).
## 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 MIT license.
## Contact
If you have any questions or suggestions, feel free to reach out to us:
- Raise an issue on the repository: [GitHub Repository](https://github.com/sodacore/core)
- Connect with us on [Discord](https://discord.gg/CgumPyVr6X)
## Acknowledgments
A special thanks to the following for their contributions, support and inspiration:
- [makeread.me](https://github.com/sodacore/core) - README Template