fun.framework

Welcome to fun.framework 👋

A fun, intuitive and expressive node.js web application framework based on express.

const express = require('express');
const router = express.Router();
const JWTMiddleware = require('../middleware/JWT.middleware');
const RoleMiddleware = require('../middleware/role.middleware');
const Controller = require('../controllers/user.controller');
const Validators = require('../validators/user');

const fun = require('fun.framework/functions/src/routes/routes.fun')(
  router,
  new Controller()
);

fun.group([JWTMiddleware])([
  fun.rest(Validators.RestValidators),
  fun.subgroup([RoleMiddleware('board')])([
    fun.post('/announcement', 'announcement', new Validators.announcement())
  ])
]);

🏠 Homepage

✨ Demo

Install

This project has an awesome CLI. To start a project execute:

npm i -g fun.framework.cli
fun.cli init

The CLI will promt some questions to generate the best base project for you. Once the CLI command has finished execute the following to start your project:

cd PROJECT_NAME
npm start

Run tests

The test are currently in development 🛠 and will be available for the next major version 👀. Please stay tune for updates ⌚️.

npm install
npm run test

📄 Documentation

An in-depth use documentation is comming soon! Please use our demo project as reference while we develop an awesome documentation.

Author

👤 neuralgeeks

• Website: https://neuralgeeks.com/
• Github: @neuralgeeks
• Instagram: @neuralgeeks

🤝 Contributing

Contributions, issues and feature requests are welcome 👍🏻. Feel free to check our issues page.

Our community just started! We are doing our absolute best to make this project the best, that is why we are taking our time to stablish the contributing methodology, an in-depth contributing guide will be available soon, we are taking our time so that the project's contribution environment is the best posible.

Keep in mind this is our first open source project, this means we are still learning how things are done, we want to do this as best as we can!

If you really want to help us through this process, contact us at [e-mail], we are waiting for you!

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 neuralgeeks.
This project is Apache--2.0 licensed.