Getting Started

• Setting up your project.
• Create your entry file
• Start the framework
• Application configuration
• Next Steps

Setting up your project.

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:

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:

// Decorators.
"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.

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).

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.

Application configuration

Currently there are only a few settings you can set on the Application:

Setting	Type	Default	Description
autowire	boolean	true	Whether the application should autowire, if disabled, you will need to import and register your modules manually, using app.register(ModuleClass).
basePath	string	process.cwd()	This is used to tell the autowire module where to search for packages, by default it will look in your src folder within the process.cwd(), this is an absolute path.
logger	instanceof Logger	new Logger()	The logger instance to use, by default it will use the built-in logger, which is a nicely coloured console logger, but you can extend the existing one and pass it in here.

Next Steps

Well at the moment, you have a basic bun http API application, that is running, but you have defined no paths, the next section explains how to make a basic application using the HTTP plugin, for more advanced features, or other packages, please refer to their documentation specifically.