Batara NPM | npm.io

Batara 😇

Javascript framework for laravel users

🤩 Motivations

Provide easy to use laravel like folder architecture on top of express application
Provide boilerplate for my internal works

🖖 Usage

Development

It's should be something like:

1. npm install -g garuda
2. garuda batara new [project-name]
3. cd [project-name]
4. npm install
5. npm run dev
6. enjoy!

Coming soon, our scaffolding tools: garuda

Contribution

Install packages: npm install
Available commands

Check development: npm run dev
Test with coverage: npm run test
Test with watcher: npm run test:watch
Build: npm run build

Enjoy

🧾 Structure

|-- Workspace
    |-- jest.config.js
    |-- nodemon.json
    |-- package.json
    |-- README.md
    |-- tsconfig.build.json
    |-- tsconfig.json
    |-- tsconfig.test.json
    |-- .github
    |-- asset
    |-- dist
    |-- doc
    |-- example
    |-- src
    |   |-- contract
    |   |-- controller
    |   |-- entity
    |   |-- error
    |   |-- middleware
    |   |-- provider
    |   |-- router
    |   |-- validator
    |-- test
    |   |-- unit
    |   |-- integration

✔️ Test & Coverages

Test coverages

📋 Docs

Complete documentations are available here

Legends:

✔️ Available with test
⚠️ Available without test (Use with your own risk 😆)
❌ Unavailable yet
❓ Ideation/request

Status	Feature	Description
✔️	Contract	definition of application shape
✔️	Controller	last place to retrieve request and returning response
✔️	Entity	class containing business logic
✔️	Error	library defined error, feel free to extend the `SystemError`
✔️	Logger	built in logger
✔️	Middleware	intermediary between request and controller
✔️	Provider	class to activate/inactivate certain configuration
✔️	Router	define how and by who certain request will be handled
✔️	Validator	built in request validator, support multi-lingual according to client preferred configuration

❓ Questions

Any question related to this library please refer to discussion

👀 Issues

There's issue with nodemon ^2.0.9 when restarting app causing port is already in use, so we downgrade to the previous version nodemon v2.0.7. Hope they fix it in the future so we can enjoy using nodemon newer version again.