OneBE Framework
- Codename: Rebuild
- Version: v2.7.9
This is a framework that we use internally at Spark Dev for most of our internal applications. To help others build applications fast using Typescript we published this framework free to use. The license under which we publish the code is MIT.
To create a new project use the following command:
npx onebe project:create <projectName>If you find bugs while using our framework, please file an issue in Github.
Also, if you manage to solve some issues, please create a Pull Request with the changes.
While this package is the framework base, we created an additional project with a base project that you can use as the starter for your application: https://github.com/1platform/onebe-project
Features of the framework:
- MongoDB already configured to be used
- Relational Database ready using TypeORM
- Authentication using Bearer Token and Basic Auth available
- Email Sending system:
- NodeMailer
- SMTP Transport
- Test Transport (ethereal email address)
- SMS Sending system: (requires Phone Number and account key and secret)
- Twilio Transport
- Vonage Transport
- i18n support using i18next
- auto-documentation of exposed endpoints in OpenAPI3 format
- ability to show/hide the documentation
- Swagger UI connected to the OpenAPI file
- Postman JSON file exposable from the application
- CORS enable
- File upload middlewares
- Logging system with various transports:
- Console
- File
- Scheduler system to schedule jobs in CRONTAB format
- Multi Factor Authentication system
- Simple Code base
- Using the Google Authenticator (or Compatible application)
- QRCode generator
- UUID V1 and V4 generator
- Shortid generator