Skip to main content

Synth: a docker bootstrapping CLI tool

Project description

![synth logo](assets/synth_logo.png)

# synth - a Docker bootstrapping tool

Read more about the creation of synth [here](https://medium.com/@jackgindi/the-making-of-synth-4045b1a746f4)

Inspired by how long it can take to set up the development of web apps, synth is a tool to help you build modular sets of Docker, Docker Compose, and CI/CD pipeline config files, as well as directory trees and wireframed files for different front- and backend web frameworks. synth can help you set up your next web application project in seconds, allowing you to start coding your idea with zero hassle.

## :warning: Dependencies

  • docker and docker-compose

  • python3

## :arrow_down: Installation

Install via pip:

` pip3 install boot-synth `

## :triangular_flag_on_post: Usage

` synth create [OPTIONS] `

![synth demo](assets/synth_basic_demo.gif)

## :hammer_and_wrench: Options

` --frontend, -f `

Your frontend framework. Currently supported options are static, dynamic, react.

` --backend, -b `

Your backend framework. Currently supported options are flask, node, django.

` --database, -d `

Your choice of database. Currently supported options are mysql, postgres, mongo, mariadb.

` --cache, -c `

Your choice of caching tool. Currently supported options are redis and memcache.

` --pipeline, -p `

Your choice of CI/CD pipeline. travis is currently the only supported option.

## :books: Coding Style Tests

Strictly followed pep8 style guide. To install:

### Regular Ubuntu 14.04 install

With apt-get

` $ sudo apt-get install python3-pep8 `

With pip3

` $ pip3 install pep8 `

### Check The Version

` $ pep8 --version 1.7.1 `

## :pencil: Version

  • 1.1.0

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## :blue_book: Authors

## :mag: License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details

## :mega: Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boot-synth-1.2.0.tar.gz (31.4 MB view details)

Uploaded Source

File details

Details for the file boot-synth-1.2.0.tar.gz.

File metadata

  • Download URL: boot-synth-1.2.0.tar.gz
  • Upload date:
  • Size: 31.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.2

File hashes

Hashes for boot-synth-1.2.0.tar.gz
Algorithm Hash digest
SHA256 8d9586494717a0ea81e9e36ef4b2a512fe7dee0d4073df6fa76a32565c27359b
MD5 ab58bbbc998accaaca233cedb185763b
BLAKE2b-256 1212ea20752e691eb53fe4825ed045dd7b231aa4f71b302998a68ef6b350fbf3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page