event_request
Version:
A Backend Server
75 lines (59 loc) • 5.79 kB
Markdown
# EventRequest
A highly customizable, async-first, speed-oriented backend server in NodeJs. The latest 3 LTS versions of node are targeted for support.
[](https://github.com/Michaelpalacce/EventRequest/actions?query=workflow%3Alinux-12.x)
[](https://github.com/Michaelpalacce/EventRequest/actions?query=workflow%3Alinux-14.x)
[](https://github.com/Michaelpalacce/EventRequest/actions/workflows/linux.16x.ci.yml)
[](https://github.com/Michaelpalacce/EventRequest/actions/workflows/linux.18x.ci.yml)
[](https://github.com/Michaelpalacce/EventRequest/actions?query=workflow%3Awindows-12.x)
[](https://github.com/Michaelpalacce/EventRequest/actions?query=workflow%3Awindows-14.x)
[](https://github.com/Michaelpalacce/EventRequest/actions/workflows/windows.16x.ci.yml)
[](https://github.com/Michaelpalacce/EventRequest/actions/workflows/windows.18x.ci.yml)
[](https://www.codacy.com/manual/Michaelpalacce/EventRequest?utm_source=github.com&utm_medium=referral&utm_content=Michaelpalacce/EventRequest&utm_campaign=Badge_Coverage)
[](https://www.codefactor.io/repository/github/michaelpalacce/eventrequest)
[](https://www.codacy.com/manual/Michaelpalacce/EventRequest?utm_source=github.com&utm_medium=referral&utm_content=Michaelpalacce/EventRequest&utm_campaign=Badge_Grade)
[](https://deepscan.io/dashboard#view=project&tid=10419&pid=13164&bid=218269)
[](https://github.com/Michaelpalacce/EventRequest)
[](https://github.com/Michaelpalacce/EventRequest)
[](https://github.com/Michaelpalacce/EventRequest)
[](https://github.com/Michaelpalacce/EventRequest)
[](https://snyk.io/test/github/Michaelpalacce/EventRequest?targetFile=package.json)
[](https://www.npmjs.com/package/event_request)
[](https://www.npmjs.com/package/event_request)
[](https://www.npmjs.com/package/event_request)
[**CHANGELOG**](https://github.com/Michaelpalacce/EventRequest/blob/master/UPDATELOG.md) || [**BENCHMARKS**](https://github.com/Michaelpalacce/EventRequest-Benchmarks)
# Documentation:
Check out the docs section or go to: [Documentation](https://github.com/Michaelpalacce/EventRequest/tree/master/docs).
## Contents
* [Getting Started](getting-started.md) - What this framework does and how does it operate?
* [Event Request](event-request.md) - The main object passed through every middleware
* [Server](server.md) - Server object used to attach to the http server
* [Routing](routing.md) - How routing works
* Functionality
* [Components](components.md) - Different components of the framework
* [plugins](plugins.md) - Documentation on all the plugins supported by the framework
* [Logging](logging.md) - Logging suite of the Framework
* [Validation](validation.md) - Validate your input parameters!
* [Error Handling](error-handling.md) - Handle errors in your app
* [Testing](testing.md) - Test your app!
* [Example Code](examples) - Look at some examples of how to use the framework
* [Example Kernel](examples/kernel.js) with everything you need to get started
# [Quick Setup](#setup)
~~~javascript
// Framework Singleton instance
const app = require( 'event_request' )();
// Add a new Route
app.get( '/', ( event ) => {
event.send( '<h1>Hello World!</h1>' );
});
// Start Listening
app.listen( 80, () => {
app.Loggur.log( 'Server started' );
});
~~~
# [External Plug-ins](#external-plugins):
* https://www.npmjs.com/package/er_memcached_data_server - memcached data server
* https://www.npmjs.com/package/er_redis_data_server - redis data server
# [Example Projects:](#example-projects)
* https://github.com/Michaelpalacce/Server - A Web App that emulates a File System on your browser and can be used to upload/download/delete files, images, audio and etc as well as stream videos directly from your browser
* https://github.com/Michaelpalacce/personal-website-vue - My website written with the framework.
* https://github.com/Michaelpalacce/SimpleSecrets - A K8S Secrets Operator