Repository files navigation

The MIC stack genesis!

Proton is a high-level Python framework that facilitates rapid server-side development with clean & pragmatic design.Thanks for checking it out!

• Proton aims at easing server-side development for all Python enthusiasts.
• Proton bootstraps templated backend by relying on code generating code with minimum dev effort.
• A few CLI commands to setup production ready server side stack with managed DB connections (Proton ships with postgresql),managed caching (Proton ships with redis), managed JWT authenticated routes, descriptive logging,managed monitoring (Prometheus & Grafana) and auto-generated openAPI specs.
• Automatessignup &login with necessaary validations.
• All of this,containerised

• Install latest version of docker on your development machine/server.
  • Linux -https://docs.docker.com/install/linux/docker-ce/ubuntu/
  • Mac -https://docs.docker.com/docker-for-mac/install/
  • Windows -https://docs.docker.com/docker-for-windows/install/
• Install latest version of docker-compose on your development machine/server (https://docs.docker.com/compose/install/)
• Clonegit clone https://github.com/1x-eng/PROTON.git & Change directorycd ~/PROTON/`
• ./cproton.sh -U yes, please comply to CLI prompts(Use absolute address; not relative for file paths)
• Wait for the platform to bootstrap; oncedone, visithttp://localhost:3000.
• Congratulations. you've got your server-side setup!

• Proton comes with out-of-box support forSignup andLogin.
• Use/signup route to sign up users to platform.
• You could swapdb by changingdb_flavor in POST payload. Supportssqlite &postgresql.
• signup andlogin validation for free. For example - What happens ifsomeone tries to signup with the same email / username?
• Use '/login' route to login after successful signup.
• See thetoken post successful login - That one command to setup the platform has prepared JWT TokenAuthentication with minimum dev effort.
• Prometheus & grafana leveraged for monitoring purposes
• Ships with a few grafana dashboards out-of-the-box. Visitlocalhost:3000/proton-grafana in yourfavourite browser and login with default credentials:
  • username: admin
  • password: admin
  • You'll be prompted to change and choose your own strong password on first login.
  • Proton Monitor
  • Proton Stack - Holistic Monitor

Proton facilitates rapid API development (theModelInterfaceController stack) with templated code generated by a few CLI commands.

Why do we need this despite many zillion frameworks? Potentially, to help get away from some of these boring tasks:

• writing; rather, re-writing same boiler plate code everytime you wanted to generate a new API usingthe framework of your choice
• managing database connectivity and dealing with connectivity issues everytime you touch codebase
• configuring cacheing & performance tuning
• configuring logging & monitoring
• authentication & authorization
• container ready backend

• Generate new API (you can do all CRUD ops on that API) by this one command./cproton.sh -n myNewApi

  • what you see above is an API endpoint auto-generated for the MIC name you provided.
  • aget route,post route andconcurrency route.
  • GET call:
  • 
  • POST call:
  • 
  • And, if you wanted to target sqlite, just changedb_flavour of your POSTJSON payload tosqlite.
  • 
  • GET call involving Concurrency / Multi-threading
  • 
    • Notice how first call took about 1 second (if not for multi-threading, this takes about 5 seconds) and subsequentcalls took only 25~35ms. Thanks for cacheing.

• For every new MIC stack that you create (viacproton.sh -s <your_api_name>), Proton generates a dedicated controller (to drive CRUD ops):

  • Example:

• Deploy using./cproton.sh -s yes

  • Notice how the route considersid as a query parameter and results comply to this query parameter.
  • Results from this route also automatically get the best of PROTON in terms of cache support, logging etc.,

• Deleting made easy, while separating concerns.

  • Notice howlogin andsignup routes remain unaffected. Similarly, if there were other MIC stacks and you destroyed one of them,all others remain as is; unaffected.

• Access logs here -./PROTON/trace

• OpenAPI specs out-of-the-box

• Proton also ships with an ability to backup vitals (secrets + db volume mounts) to cold storage (Dropbox)

• To initiate backup,

  • Create a dropbox account for yourself and create an app -https://www.dropbox.com/developers/apps
    • An example would be:
      • API type - Dropbox API
      • Type of data access as "App folder - Access to a single folder created specifically for your app"
      • App name as "PROTON Backup"
      • Create App & then click on "Generate access token". You'll need this token later.
  • With your access token handy, now navigate tobackup folder in Proton home directory.
  • Initiate backup using./scripts/proton_backup_orchestrator.sh
  • Comply with command line prompts and provide access token when asked for.
  • There is an audit trail just in case. You maycat those reports available underbackup/reports folder.

• Similar to backups, Proton also ships with ability to restore from remote dropbox location to your local machine or remote server.

• In order to initiate restoration, ensure you have the access token handy for your remote backup folder and navigate tobackup folder.

  • Initiate restoration using./scripts/proton_restore.sh

• If you have a pre-configured DNS handy, use ./deployer.sh -d <your_dns>
• If you wanted to run the platform for the first time and ok to proceed with defaults; then use:./deployer.sh -a yes
• If you were using Proton's backup services, to kickstart restoration use this:./deployer.sh -r yes

• [Step - 1] Install Docker and Docker-Compose

    sudo apt-get update    sudo apt-get install -y docker    sudo apt-get install -y docker-compose

• [Step - 2] Enable USER to run docker

    sudo groupadd -e docker    sudo gpasswd -a${USER} docker    newgrp docker

• [Step - 3] Install NGINX and configure HTTP reverse proxy

    sudo apt-get update    sudo apt-get install -y nginx    unlink /etc/nginx/sites-enabled/defaultcd /etc/nginx/sites-available    cat<<EOT > reverse-proxy.conf    server {                    listen 80;                    listen [::]:80;                    server_name <dns here>;                    access_log /var/log/nginx/reverse-access.log;                    error_log /var/log/nginx/reverse-error.log;                    location / {                                proxy_pass http://127.0.0.1:3000;                }            }    EOT    ln -s /etc/nginx/sites-available/reverse-proxy.conf /etc/nginx/sites-enabled/reverse-proxy.conf    sudo nginx -t    sudo service nginx restart

• [Step - 4] Configure HTTPS in NGINX reverse proxy

    sudo apt-get update    sudo apt-get install -y software-properties-common    sudo add-apt-repository ppa:certbot/certbot -y    sudo apt-get update    sudo apt-get install -y python-certbot-nginx    sudo certbot --nginx --non-interactive --agree-tos -m<email> -d<dns eg. temp.com here>

• [Step - 5] Grant permission to PROTON Stack

cd~/PROTON    sudo chmod 777 -R ./

• Start Proton stack using -./cproton.sh -U yes

PROTON is a product of Adroit Software Corporation (ABN 426 3819 0066) (https://adroitcorp.com.au)

BSD 3-Clause License

Copyright (c) 2018, Pruthvi Kumar & Adroit Software Corporation (https://www.adroitcorp.com.au)All rights reserved.

Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, thislist of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice,this list of conditions and the following disclaimer in the documentationand/or other materials provided with the distribution.

• Neither the name of the copyright holder nor the names of itscontributors may be used to endorse or promote products derived fromthis software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THEIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AREDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLEFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIALDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS ORSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVERCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USEOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.