Giter VIP home page Giter VIP logo

catalogue's Introduction

Structure

├── install.sh              # Install the python env.
├── app.py                  # Application entry point
├── api                     # REST api definition using swagger spec.
├── sql                     # SQL statements to init the database, user and create the relative tables
├── src                      
│   ├── services
│   │   ├── session
│   │   │   ├── session.py       # python entry point 
│   │   │   ├── api.py           # REST entry point and ble print definition, it is the only place where flask is used
│   │   │   ├── core  # logic / controller
│   │   │   └── test  # unit test
│   │   ├── image
│   │   │   ├── core
│   │   │   └── test
│   │   ├── live
│   │   │   ├── core
│   │   │   └── test
│   │   ├── reader
│   │   │   ├── core
│   │   │   └── test
│   │   └── availability
│   │       ├── core
│   │       └── test
│   └── dal                # SQLAlchemy model generated automatically from the SQL statements
├── test
│   └── postman            # postmand tests

How to dev in local

Prerequisite

  • Python 3.X
  • Docker

Steps

Setup environment

Python and app

source install.sh

Mysql via Docker

The first time in order to setup

 docker run --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 -d mysql:8.0.16

To stop

docker stop mysql

To start

docker start mysql

The connection string is:

mysql+pymysql://root:123456@localhost:3306/db

Run the sql script present under sql folder to create a database and the expected Tables.

Start app

python app.py

How to test in local

sh run_codequality.sh

catalogue's People

Contributors

harshilpatel99 avatar

Watchers

Kostas Georgiou avatar Vivek Nathani avatar

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.