8000 GitHub - apapay/para: A back-end framework for the cloud.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

apapay/para

 
 

Repository files navigation

Logo

A general-purpose backend framework for the cloud.

Maven Central Join the chat at https://gitter.im/Erudika/para

Para was designed as a simple and modular backend framework for object persistence and retrieval. It helps you build applications faster by taking care of the backend. It works on three levels - objects are stored in a NoSQL data store or any old relational database, then automatically indexed by a search engine and finally, cached.

The name "pára" means "steam" in Bulgarian. And just like steam is used to power stuff, you can use Para to power your mobile or web application backend.

Para can be used in two ways - as the backbone of your JVM-based application or as a standalone API server with multiple applications and clients connecting to it.

See how Para compares to other open source backend frameworks.

Features

  • RESTful JSON API secured with Amazon's Signature 4 algorithm
  • Database-agnostic, designed for scalable data stores (DynamoDB, Cassandra, MongoDB, etc.)
  • Full-text search (Elasticsearch by default)
  • Distributed object cache (Hazelcast by default)
  • Multi-tenancy support - each app has its own table, index and cache
  • IoT support and integration with AWS and Azure
  • Flexible security based on Spring Security (Social login, JWT support, CSRF protection, etc.)
  • Simple but effective resource permissions for client access control
  • Robust constraint validation mechanism based on JSR-303 and Hibernate Validator
  • Per-object control of persistence, index and cac 8000 he operations
  • Modular design powered by Google Guice and support for plugins
  • I18n utilities for translating language packs and working with currencies
  • Standalone executable WAR with embedded Jetty
  • Para Web Console - admin user interface

Architecture

+----------------------------------------------------------+
|                  ____  ___ _ ____ ___ _                  |
|                 / __ \/ __` / ___/ __` /                 |
|                / /_/ / /_/ / /  / /_/ /                  |
|               / .___/\__,_/_/   \__,_/     +-------------+
|              /_/                           | Persistence |
+-------------------+  +-----------------+   +-------------+
|      REST API     |  |     Search      |   |    Cache    |
+---------+---------+--+--------+--------+---+------+------+
          |                     |                   |
+---------+---------+  +--------+--------+   +------+------+
|  Signed Requests  |  |  Search Index   +---+  Data Store |
|  and JWT Tokens   |  | (ElasticSearch) |   |    (Any)    |
+----+---------^----+  +-----------------+   +-------------+
     |         |
+----v---------+-------------------------------------------+
|  Clients : JavaScript, PHP, Java, C#, Android, iOS, etc. |
+----------------------------------------------------------+

Documentation

Quick Start

  1. Download the latest executable WAR
  2. Execute it with java -jar para-X.Y.Z.war
  3. Call curl localhost:8080/v1/_setup to get the access and secret keys
  4. Open Para Web Console or integrate with one of the API clients below.

Building Para

Para can be compiled with JDK 6 and up, but we recommend running it on JDK 8+.

To compile it you'll need Maven. Once you have it, just clone and build:

$ git clone https://github.com/erudika/para.git && cd para
$ mvn install -DskipTests=true

Standalone server

You can run Para as a standalone server by downloading the executable WAR and then:

$ java -jar para-X.Y.Z.war

The you can browse your objects through the Para Web Console console.paraio.org. Simply change the API endpoint to be your local server and connect your access keys. The admin interface is client-side only and your secret key is never sent over the the network. Instead, a JWT access token is generated locally and sent to the server on each request.

Alternatively, you can grab the WAR file and deploy it to your favorite servlet container.

Maven dependency

You can also integrate Para with your project by adding it as a dependency. Para is hosted on Maven Central. Here's the Maven snippet to include in your pom.xml:

<dependency>
  <groupId>com.erudika</groupId>
  <artifactId>para-server</artifactId>
  <version>1.21.1</version>
</dependency>

Command-line tool

$ npm install -g para-cli

API clients

Use these client libraries to quickly integrate Para into your project:

Database integrations

Use these DAO implementations to connect to different databases:

Wishlist / Roadmap

  • DAO implementation for PostgreSQL, etc.
  • Server-side JavaScript support for implementing custom API resources
  • Integrations with Google App Engine, Heroku, DigitalOcean
  • GraphQL and/or (JSON API) schema support
  • Swagger support

Contributing

  1. Fork this repository and clone the fork to your machine
  2. Create a branch (git checkout -b my-new-feature)
  3. Implement a new feature or fix a bug and add some tests
  4. Commit your changes (git commit -am 'Added a new feature')
  5. Push the branch to your fork on GitHub (git push origin my-new-feature)
  6. Create new Pull Request from your fork

Please try to respect the code style of this project. To check your code, run it through the style checker:

mvn validate

For more information see CONTRIBUTING.md

Hosting

We offer hosting and premium support at paraio.com where you can try Para online with a free developer account. Browse and manage your users and objects, do backups and edit permissions with a few clicks in the web console. By upgrading to a premium account you will be able to scale you projects up and down in seconds and manage multiple apps.

License

Apache 2.0

About

A back-end framework for the cloud.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%
0