https://github.com/kevinam99/reuben

Reuben is a BaSH command line utility that helps you create a Flask project template.
https://github.com/kevinam99/reuben

bash command-line flask jinja python python-flask python3 web-framework webdevelopment wsgi

Last synced: 2 months ago
JSON representation

Reuben is a BaSH command line utility that helps you create a Flask project template.

• Host: GitHub
• URL: https://github.com/kevinam99/reuben
• Owner: kevinam99
• License: mit
• Created: 2020-05-19T18:35:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-28T18:20:03.000Z (over 5 years ago)
• Last Synced: 2025-01-12T17:46:48.169Z (11 months ago)
• Topics: bash, command-line, flask, jinja, python, python-flask, python3, web-framework, webdevelopment, wsgi
• Language: Shell
• Homepage:
• Size: 13.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Reuben

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

![Star this repository](https://img.shields.io/github/stars/kevinam99/Reuben?style=social)

I wanted to quickly get started with a new Flask project as a beginner. But I found setting the project manually was a waste of time. I don't want to go through the same thing every time I decide to start a new Flas project. So, I created Reuben.

Reuben is a BaSH command line utility that helps you get started with your Flask project by just giving your project's name.

### Usage

1. Download the script.

2. Run ``` chmod +x reuben.sh ``` to make it executable.

3. Run ```./reuben.sh``` and follow the instructions!

### Add Reuben to your PATH

    - Save the script as reuben (without the .sh extension) in some ~/bin.

    - Add ~/bin to your PATH, typing export PATH=$PATH:~/bin

    - If you need it permanently, add that last line in your ~/.bashrc. If you're using zsh, then add it to ~/.zshrc instead.

    - Then you can just run ```reuben``` and it will run anywhere

Note that if you ```export``` the PATH variable in a specific window it won't update in other bash instances. See [this answer on StackOverflow](https://stackoverflow.com/a/20054809)

The project structure is inspired from this [Scotch.io article](https://scotch.io/tutorials/getting-started-with-flask-a-python-microframework).

Show your support by giving this repo a star! 

![Star this repository](https://img.shields.io/github/stars/kevinam99/Reuben?style=social)

### Reach out to me on:

1. [Twitter](https://www.twitter.com/kevin_codes)

2. [Instagram](https://www.instagram.com/kevin.codes)

3. Email 

4. [LinkedIn](https://www.linkedin.com/in/kevin-a-mathew)

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/kevinam99)