|
|
|
<br>
|
|
|
|
<div align="center">
|
|
|
|
<a href="https://dev.egov.gy//christopher.mckay/caffeinated-whale">
|
|
|
|
<img src="images/cw.png" alt="Logo" width="300" height="300">
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<h3 align="center">Caffeinated Whale</h3>
|
|
|
|
|
|
|
|
<div align="center">
|
|
|
|
Local Frappe deployment simplified
|
|
|
|
<br/>
|
|
|
|
<br/>
|
|
|
|
<a href="https://dev.egov.gy/christopher.mckay/caffeinated-whale/issues/new">Report Bug</a>
|
|
|
|
.
|
|
|
|
<a href="https://dev.egov.gy/christopher.mckay/caffeinated-whale/issues/new">Request Feature</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
## Table Of Contents
|
|
|
|
|
|
|
|
* [About the Project](#about-the-project)
|
|
|
|
* [Built With](#built-with)
|
|
|
|
* [Getting Started](#getting-started)
|
|
|
|
* [Prerequisites](#prerequisites)
|
|
|
|
* [Installation](#installation)
|
|
|
|
* [License](#license)
|
|
|
|
* [Authors](#authors)
|
|
|
|
|
|
|
|
## About The Project
|
|
|
|
|
|
|
|
<!-- <img alt="Shell running the _run.py_ script" width="600" src="[link to script demo]"> -->
|
|
|
|
|
|
|
|
<!-- The above is running cwi ([source](./_run.py)). -->
|
|
|
|
|
|
|
|
Like any good automated setup it started as a way for me to be laz-- I mean increase my productivity and streamline tasks but then my colleagues liked it so...
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
Let's get brewing...
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
|
|
You'll need a few ingredients before you can make you coffee
|
|
|
|
|
|
|
|
* docker
|
|
|
|
|
|
|
|
* winget
|
|
|
|
|
|
|
|
* python 3.11
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
```shell
|
|
|
|
git clone https://cwi:htM_PG6LoWj_Nkw4kT9M@dev.egov.gy/christopher.mckay/caffeinated-whale.git
|
|
|
|
cd caffeinated-whale
|
|
|
|
python .\installer.py
|
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
CWI has 2 modes - a basic mode that give you just what you need to get your frappe project up and running and a pro mode for more advanced devs that gives you some additional features and control
|
|
|
|
|
|
|
|
* Basic mode
|
|
|
|
```shell
|
|
|
|
python \._run.py
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
* Pro mode
|
|
|
|
```shell
|
|
|
|
python \._run.py -m pro
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
Distributed under the MIT License. See [LICENSE](https://dev.egov.gy/christopher.mckay/caffeinated-whale/-/blob/master/LICENSE) for more information.
|
|
|
|
|
|
|
|
## Authors
|
|
|
|
|
|
|
|
* **Christopher McKay** - *and his keyboard* - [Christopher McKay](https://dev.egov.gy/christopher.mckay) - *using his keyboard* |
|
|
|
\ No newline at end of file |
