From 0f5ec82f6f110f536de14577ed0750624dce9a61 Mon Sep 17 00:00:00 2001 From: JCharis Date: Wed, 11 Aug 2021 13:43:28 +0300 Subject: [PATCH] Creating Docs for genesis --- docs/index.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 7 ++++++ 2 files changed, 66 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..1ea768e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,59 @@ +### Webgenesis +A simple command line interface for generating hello-world starter apps for +quick setup + + +#### Why Webgenesis? +When building web apps, it can become common to be starting from the same or similar set of code and basic project structure. Hence webgenesis comes in to +reduce this burden of writing the same code when starting up a web project + + + +#### Installation +```bash +pip install webgenesis +``` + + +#### Usage +```bash +webgenesis --help + +``` + + +#### Create A Project for a web framework ++ Uses the default 'hello-' as project folder ++ Supported frameworks include + - flask + - streamlit + - express + - koajs + - bottle + - tornado + +```bash +webgenesis create flask + +``` + +```bash +webgenesis create streamlit + +``` + +#### Create A Project using Custom/Specified Project +```bash +webgenesis create flask -f myflaskapp +``` + + + +#### About ++ Maintainer: Jesse E.Agbe(JCharis) ++ Jesus Saves @JCharisTech + + +#### Contributions +Contributions are welcome. In case you notice a bug let us know. +Happy Coding \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..16ebc82 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,7 @@ +site_name: WebGenesis +site_url: https://github.com/jcharistech/webgenesis +nav: + - Home: index.md + - About: about.md + +theme: readthedocs