Skip to content
Backend server for IDl0T/AIwaffle
Python HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
.idea
AIWaffle-website @ 0aa6f76
AIwaffle @ 691a68e
docs
server1
server1_extra
tests
.gitignore
.gitmodules
LICENSE
MANIFEST.in
readme.md
requirements.txt
setup.cfg
setup.py

readme.md

AIwaffle_server1

Version 0.1.6

Build Status

Backend server for IDl0T/AIwaffle

Components

Web server

Network

Using Flask framework

Database

SQLAlchemy + SQLite

Models

  • Users: stores user auth information
  • Posts: stores post information

Site map

  • / Index page
  • /auth/ the user login/register pages
  • /blog/ the blog page
  • /model/ the model view
  • /api/ restful api
  • /static/ static files
  • /tutorial/ tutorial web pages
  • /home Index page (same as /)
  • All the other routes (include 404) will be required to /

Documentation

Auth: TODO

Blog: docs/blog.md

API: docs/api.md

Extra server

An internal server that runs a something unrelated to web

Could be integrated to the web server

How to deploy

  1. Clone this repo
    git clone https://github.com/jimmy-zx/AIwaffle_Server1.git
    cd AIwaffle_Server1
  2. Initialize submodules git submodule update --init
  3. Install dependencies pip3 install -r requirements.txt
  4. Config the server
    mkdir instance
    $EDITOR instance/config.py
    • A secret key is recommend to config
    • If you don't want an extra_server, set
      USE_EXTRA_SERVER=False
  5. Choose an production server to run the application
    • Current environment uses waitress
    pip3 install waitress
    waitress-run --call 'server1.create_app

Release notes

Latest

Version 0.1.6

  • Updated and fixed routing
  • Updated new submodule

Older versions

Click to expand

Version 0.1.5

  • Completed documentation for statistics
  • Updated tests
  • Added production deployment documentation

Version 0.1.4

  • Added statistics support

    Records the total requests on the server

    Could be accessed via /api/statistics/total

    See the api documentation for details

TODO List

Version 0.1.7

  • Remove posts view

Version 0.2.0

  • Finish auth documentation
  • Finish backend documentation

Version 0.2.1

  • Automatic deploy

License and copyright

Licensed under the MIT license

Copyright 2019-2020

Model

Front end

You can’t perform that action at this time.