Giter Club home page Giter Club logo

citadel's Introduction

FlaskWebService

A simple flask web service to store and retrieve data Project Website

Build Status

Dependency for native running

Python 3.5+ . .

Dependency for Docker

Docker

Install

Install software listed in requirements.txt and pip-packages.list

Create a database in InfluxDB called 'citadel'

  • influx
  • CREATE DATABASE citadel

Running Instruction

Run natively

python app/main.py

Running with Docker

  1. Install Docker from here
  2. Run "run_with_docker" file. It may ask authority elevation (sudo.)
    Currently the script is based on Linux environment.
    Same script can be easily generated for Windows and Mac.

API Documentation

Generate interactive UI

  1. Specify your machine's IP in app/config.py for both CITADEL_HOST and SERVER_NAME
  2. Run Citadel with "python app/main.py"
  3. API doc will be accessible from your browser at "http://host:port/api/doc"

Generate static HTML

  1. Citadel should have run once before generating API doc. Needs JAVA>7.
  2. Run "bash gen_api_doc.sh"
  3. Generated document is located in doc/api/index.html

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.