Giter Site home page Giter Site logo

backend's Introduction

SafeAck Backend

APIs for SafeAck Applications

  • Tests Status Run SafeAck API App Tests

Usage ๐Ÿฆโ€๐Ÿ”ฅ

  • Install and configure Docker ๐Ÿ‹

  • Install python ๐Ÿ

  • Clone repo

    git clone https://github.com/SafeAck/backend.git
  • Usage SafeAck Deployment Manager script for managing deployment

    python sdm.py -h
  • Deploy Backend

    python sdm.py deploy

    Note: use python3 instead of python

  • Stop Backend

    python sdm.py stop
  • Start Backend. Below command needs to be used once backend has been deployed and you need to start it again.

    python sdm.py start
  • Upgrade Infra

    python sdm.py upgrade
  • Migrate Manually

    python sdm.py migrate
  • Get backend container shell access

    python sdm.py shell

Dev

Hi ๐Ÿ‘‹, If you'd like to contribute to SafeAck project then below sections are for you ๐Ÿ˜Ž

Config

Update env and alembic.ini file when making changes to db

  • import newly generated model in safeack-backend/models.py

  • create migrations

    alembic revision --autogenerate -m "init"
  • apply migrations

    alembic upgrade head

Shell Usage

  • Trigger shell
python -m safeack_backend.scripts.shell
  • Enter python or db queries
from ..models import User
db.query(User).all()

backend's People

Contributors

dmdhrumilmistry avatar

backend's Issues

Store and load results from s3 bucket

Store and load scan results from s3 bucket

Storing Results Flow

  • Scan APIs and store results in local temp directory
  • upload file to user's s3 bucket
  • send path to safeack backend and store it in a model.

Retrieving Flow

  • Use stored path
  • sanitize path
  • validate user perms
  • return presigned url

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.