@sodacore/ui
Version:
Sodacore UI is a powerful JSON-based DSL for describing web pages that can be rendered by a frontend JavaScript framework.
183 lines (127 loc) • 6.51 kB
Markdown
<br/>
<div align="center">
<a href="https://github.com/sodacore/core">
<img src="https://sodacore.dev/logo.png" alt="Logo" width="80" height="80">
</a>
<h3 align="center">Sodacore</h3>
<p align="center">
Sodacore is a bun-powered framework for building server-side applications utilising the lighting fast <a href="https://bun.sh" target="_blank">Bun</a> runtime.<br />The <code>@sodacore/ui</code> package provides a custom JSON-based DSL for describing webpages and then having them rendered by a frontend framework, we shall offer a Vue-based one.
<br/>
<br/>
<a href="https://sodacore.dev"><strong>Explore the docs »</strong></a>
<br/>
<br/>
<!-- <a href="https://www.makeread.me/">View Demo .</a> -->
<a href="https://github.com/sodacore/core/issues/new?labels=bug&template=bug_report.md">Report Bug</a>
⚬
<a href="https://github.com/sodacore/core/issues/new?labels=enhancement&&template=feature_request.md">Request Feature</a>
</p>
</div>
## 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
There are two ways of getting started with your project, you can either use our CLI or manually setup your project.
### CLI Setup
To get started with the CLI, you can run the following command:
```bash
bun create @sodacore
```
This will install and launch the command line, it simply asks you about your project, and then installs the packages and writes the files, it will also modify the directory to correctly reflect the Sodacore project structure, see below:
[](https://sodacore.dev/images/sodacore-create.svg)
### Manual setup
To start with find a home (folder) for your project, once you have done this, ensure your Bun install is up to date.
If you haven't already install Bun, you can go to their website and follow the instructions. To update Bun, simply call bun upgrade.
Let's initialise a Bun project, you can do this by running:
```bash
bun init
```
Ensure you select the "Blank" template.
This will initialise the current project folder, from here, we need to tweak the `tsconfig.json` file due to our use of legacy decorators, add these to the `compilerOptions` section:
```jsonc
{
// ...
"compilerOptions": {
// ...
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"useDefineForClassFields": false
}
}
```
You can see ours here: `tsconfig.json`, I would also suggest removing the DOM lib, as this is a server-side project.
Lastly we suggest deleting the `index.ts` file that is at the root, and make yourself a `src` folder.
### Create your entry file
Once you're setup, you can easily get started with the framework by creating yourself an entry file: ./src/main.ts and then put the following code in it:
All documentation will be written in TypeScript going forward.
```ts
import { Application } from '@sodacore/core';
import HttpPlugin from '@sodacore/http';
const app = new Application({
autowire: true,
// Other settings...
});
app.use(new HttpPlugin({
port: 8080,
}));
app.start().catch(console.error);
```
### Start the framework
You can start the framework by doing:
We suggested to put it in your package.json under scripts section and then you can do bun dev (set it as the dev script).
```bash
bun run ./src/main.ts --target=bun
```
We set the target to Bun by default, so that any additional libraries will force bun as well, but you can omit that flag.
## 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