https://github.com/chitralverma/schnapps
Schnapps is a precise toolkit to rapidly develop production-grade, secure and self-contained WebApps and REST APIs over HTTP and WebSockets.
https://github.com/chitralverma/schnapps
authentication authorization http microservices rest rpc scala web websocket
Last synced: 3 months ago
JSON representation
Schnapps is a precise toolkit to rapidly develop production-grade, secure and self-contained WebApps and REST APIs over HTTP and WebSockets.
- Host: GitHub
- URL: https://github.com/chitralverma/schnapps
- Owner: chitralverma
- License: apache-2.0
- Created: 2020-06-21T15:51:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T01:46:54.000Z (over 2 years ago)
- Last Synced: 2024-04-24T05:02:17.311Z (about 1 year ago)
- Topics: authentication, authorization, http, microservices, rest, rpc, scala, web, websocket
- Language: Scala
- Homepage:
- Size: 174 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
====
[](https://codecov.io/gh/chitralverma/schnapps)
> A clever exaggeration of apps-in-a-snap.
>
> _Noun_: A type of alcoholic beverage that may take several forms.
> _Origin_: derived from the colloquial German word Schnaps [/ʃnɑːps/](https://en.wikipedia.org/wiki/Help:IPA/Standard_German)
Schnapps is a precise toolkit to rapidly develop production-grade, self-contained WebApps and RESTful services over HTTP and WebSockets.
It is completely written in `Scala` and is compatible with `Java` as well.
Backend developers spend a big chunk of their precious time on redundant activities across projects like app
configuration & its management, connectivity to external systems, integration of auth mechanisms, app packaging, etc.
They get bound to excessively complex tools/ frameworks, and eventually, these tools drive the development and not the other way around.
Schnapps provides the boilerplate code for all these activities so that developers can focus on what matters the most - **Application Logic**.
## Features
- Standardized JSON-based project configuration out-of-the-box
- Allows embedded servers (built on [Apache Dubbo](https://dubbo.apache.org/)) that hosts _mostly managed services_
- Inbuilt authentication and authorization using [Apache Shiro](https://shiro.apache.org/)
- Allows synchronous/ asynchronous web applications and services over HTTP and RPCs
- Managed connectors to external systems like LDAP, JDBC, etc.
## ~~Quick~~ SchnappStart
Getting started with Schnapps is as straight-forward as it can get, as exactly 3 things need to be done,
- Get it
- Configure it
- Use it
### Get Schnapps
To get Schnapps, you need to add its dependency according to your build tool.
- For Maven-based projects, add the following repository and dependency to your `pom.xml`
```$xslt
...
ossrh
https://oss.sonatype.org/content/repositories/snapshots/
...
```
```$xslt
...
com.github.chitralverma
schnapps-core
1.0-SNAPSHOT
...
```
### Use Schnapps
Depending on whether you use Schnapps in `Scala` or `Java` project, the usage syntax changes ever so slightly.
##### Configuring the project
Use the minimum configuration template available [here](schnapps-examples/src/main/resources/rest-services-min-config.json) and pass the
location of the JSON config file as the first argument to the program. To initialize the config, follow the steps below,
In `Java` projects,
```$xslt
Configuration config = ConfigParser.parse(args);
```
In `Scala` projects,
```$xslt
val config: Configuration = ConfigParser.parse(args);
```
**Note:**
- `Configuration` is a singleton. That means, once it's parsed, you can refer to it anywhere in the code statically
by `ConfigParser.getConfiguration()`.
- A complete config template is available [here](schnapps-examples/src/main/resources/rest-services-full-config.json).
##### Writing your first service
For `Java` projects, the examples are available [here](schnapps-examples/src/main/java).
For `Scala` projects, the examples are available [here](schnapps-examples/src/main/scala).
##### Running the Server
After the configuration has been successfully initialized (see [here](#configuring-the-project)), boot up the server(s)
as following,
In `Java` & `Scala` projects,
```$xslt
Server.bootUp(config);
```
This will load the different entities mentioned in the configuration like Application information, Service Registry, Protocols
and Services. To await the server(s) till they are given an explicit termination signal, do,
In `Java` & `Scala` projects,
```$xslt
Server.await();
```
### Advanced Topics
You can head over to the [Wiki](https://github.com/chitralverma/schnapps/wiki) for more advanced topics like,
- Configuring Authentication
- Configuring the Server
- Configuring the Externals
- Service Discovery & Load Balancing
- Implementing Custom externals
### Contributing
I'm interested in building a community and would welcome any thoughts, suggestions and/ or patches.
You can reach me [@here](mailto:[email protected]).
### License
Copyright 2020 Chitral Verma
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)