https://github.com/bracketed/jova.js
A semi-advanced Express.js framework by Bracketed Softworks! 🎉🎉
https://github.com/bracketed/jova.js
expressjs framework javascript nodejs typescript
Last synced: 9 months ago
JSON representation
A semi-advanced Express.js framework by Bracketed Softworks! 🎉🎉
- Host: GitHub
- URL: https://github.com/bracketed/jova.js
- Owner: Bracketed
- License: apache-2.0
- Created: 2024-09-03T18:13:29.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-25T00:31:55.000Z (11 months ago)
- Last Synced: 2025-06-16T12:15:36.561Z (10 months ago)
- Topics: expressjs, framework, javascript, nodejs, typescript
- Language: TypeScript
- Homepage: https://jova.js.org
- Size: 22 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
@bracketed/jova.js
A semi-advanced Express.js framework by Bracketed Softworks!
This is a package built revolving around [Express.js](https://www.npmjs.com/package/express) to allow the easy usage of Express' API and adding extra things like built in middlewares, event listeners etc.
Documentation & Guide available at , **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](https://www.npmjs.com/package/express) that uses [@bracketed/logger](https://www.npmjs.com/package/@bracketed/logger) for logging.
\- It utilises a range of packages to bring you the best experience!
Summary (Directory)
- [Installation](#Installation)
- [Yarn](#YarnInstall)
- [Npm](#NpmInstall)
- [Usage](#Usage)
- [Contribution](#Contribution)
Installation
Install via `yarn` or `npm`:
Yarn:
```sh
yarn add @bracketed/jova.js
```
Npm:
```sh
npm install --save @bracketed/jova.js
```
Usage
Jova.js has a specific file structure it works by, this is shown below:
```txt
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.
```typescript
// ESM
import { JovaServer } from '@bracketed/jova.js';
const Jova = new JovaServer();
await Jova.listen(3000);
```
```typescript
// 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](https://github.com/bracketed/jova.js) or the direct folder [here](https://github.com/Bracketed/jova.js/tree/master/test).
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](https://jova.js.org/docs/Guide/Events)
**Routes** - [Via the documentation at jova.js.org](https://jova.js.org/docs/Guide/Routes)
**Middlewares** - [Via the documentation at jova.js.org](https://jova.js.org/docs/Guide/Middlewares)
Contribution & Help
Feel free to contribute to this project, join our [discord](https://discord.com/invite/JZ4939cvMT) 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 Softworks - Website | Discord | Github | Twitter | Back To The Top
