GES233 / Chestnut

Scaffold for building demostration and presentation.

[WIP] Chestnut 🌰

Warning

This project is still in progress and may be deprecated at any time.

简体中文 繁體中文

A scaffold built with Sanic and AppRun.

TOC

• Feature
• Getting Start
• Usage
  • Install and running
  • Dependencies
• Contributors
• Thanks

Feature

• DDD + Clean Architecture => obey Open-Close Principle, and easy to extend
• Fewer params in command => easy to read and operate

Getting Start

Download the source code and run launch app.

python virtualenv venv python=3.10
source venv/bin/activate
git clone https://github.com/GES233/Chestnut.git
python -m pip install -r requirements_basic.txt
python -m chestnut launch

Then, open http://127.0.0.1:6699 in browser and follow it to install.

Usage

Install and running

Before running, you need install Python and Git.

Dependencies

• Python
  • WebUI(Launch):
    • click command
    • sanic server and framework
    • jinja_2 template to render HTML file
    • pydantic serialization & deserialization
    • tomli (less than Python 3.11)
    • aiosqlite for Database
    • SQLAlchemy ORM(bind Python object with database)
    • Alembic database migrate
  • WebUI(Required for appearance):
    • mistune Markdown
    • Pygments Let code colorful
  • WebUI(All):
    • Launch items
    • sanic_ext Sanic's official extensions
  • Security:
    • ecdsa Cryptography
• Decoration for launch application
  • PicoCSS
• Front-end[Optional]
  • Node: If node installed, it will re-complie the front-end in /webapp folder. If you want to re-development, it is required
  • Tailwind CSS for decorate
  • AppRun for SPA
  • Vite as a frontend tooling

Contributors

Myself, and...

Thanks