Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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-<webframework>' 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
7 changes: 7 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
site_name: WebGenesis
site_url: https://github.com/jcharistech/webgenesis
nav:
- Home: index.md
- About: about.md

theme: readthedocs