Skip to main content

index

Bracketed logo
Bracketed Softworks - Website | Discord | Github

@bracketed/jova.js

A semi-advanced Express.js framework by Bracketed Softworks! This is a package built revolving around Express.js to allow the easy usage of Express' API and adding extra things like built in middlewares, event listeners etc.

Documentation & Guide available at https://jova.js.org, the majority of the content which used to be part of our README.md is now at our js.org website.

What is this?

- A Framework package built for Express.js that uses @bracketed/logger for logging. - It utilises a range of packages to bring you the best experience! Some of these are, ioRedis for Database-Based ratelimit buckets, CORS for CORS middleware and a few minor packages that can be found in the dependencies tab for small tasks in Jova.js.

Summary (Directory)

Installation​

Install via yarn or npm:

Yarn:

yarn add @bracketed/jova.js

Npm:

npm install --save @bracketed/jova.js

Usage​

Jova.js has a specific file structure it works by, this is shown below:

project
│   index.ts
│
└───events
│   │   Ready.ts
│   │   Error.ts
│   │   ...
│   │
│   └───more-events (subfolders are supported)
│       │   Mount.ts
│       │   Route.ts
│       │   ...
│
└───routes (subfolders are supported)
│   │   Route.ts
│   │   Index.ts
│   │   ...
│
└───middlewares (subfolders are supported)
│   │   Middleware1.ts
│   │   Middleware2.ts
│   │   ...
│
└───static (subfolders are supported)
    │   file1.css
    │   file2.txt
    │   ...

Jova.js also has two other exports, @bracketed/jova.js/types and @bracketed/jova.js/decorators.

  • @bracketed/jova.js/decorators - For decorators usage in handlers such as route handlers, event handlers and middleware handlers.
  • @bracketed/jova.js/types - Typings for Jova.js, used in routes, middlewares, events etc.

Initiating a new Jova Server.

// ESM
import { JovaServer } from '@bracketed/jova.js';

const Jova = new JovaServer();

await Jova.listen(3000);
// CJS
const { JovaServer } = require('@bracketed/jova.js');

const Jova = new JovaServer(); // All options for JovaServer are documented in the instance as jsDocs

await Jova.listen(3000);

You can find an application example in the Jova.js repository here or the direct folder here.

The default Express API can be utilised from the default Jova instance after being initiated e.g: get(), post(), etc or via the container object exported by @bracketed/jova.js.

However, you can set up routes, middlewares and event listeners like this:

Events - Via the documentation at jova.js.org

Routes - Via the documentation at jova.js.org

Middlewares - Via the documentation at jova.js.org

Contribution & Help

Feel free to contribute to this project, join our discord and help us with future developments of Project Bracketed & Packages by Bracketed Softworks. Please also notify us of errors within our projects as we may not be aware of them at the time.


Thanks for using our packages!

Bracketed logo Bracketed Softworks - Website | Discord | Github | Twitter | Back To The Top

Discord Banner