README.md

Fork My Repo

A web application that allows you to fork your own repository!

Report Bug · Request Feature

Table of Contents

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Setup
   • Set up the Vagrant Box
   • SSH to the machine
   • Putty setup (optional)
   • Install on AWS, Google, Digital Ocean, etc
4. Other Deets
   • Architecture
5. License
6. Acknowledgments

About The Project

Sometimes it's a struggle to share your forks with others.. this project does just that!

This project utilizes a template called bento-reloaded, and has been simplified based on the project's requirements.

(back to top)

Built With

• Fast API
• Bootstrap

(back to top)

Getting Started

Prerequisites

This project uses Vagrant for building and managing virtual machine environments in a single workflow. https://www.vagrantup.com/downloads

(back to top)

Setup

Set Up the Vagrant box

1. get the deps:
   • Vagrant
   • Virtualbox
   • optional: winscp, putty, puttygen
2. open terminal/cmd in this dir
3. vagrant up

SSH to the machine

2 options:

• vagrant ssh
• your ssh client of choice

Putty setup (optional)

TO USE PUTTY, convert the autogenerated private key to ppk

• autogenerated: ./.vagrant/machines/default/virtualbox/private_key (pem)
• putty: ./.vagrant/machines/default/virtualbox/private.ppk (putty) To Convert:

1. run generate_putty_key.bat after 'vagrant up' completes
   • NOTE: you'll need winscp in your path for this step to work
   • ALTERNATIVELY: convert the key manually using puttygen
2. configure putty session:
   • user: vagrant
   • host: localhost
   • port: 2222
   • private key: ./.vagrant/machines/default/virtualbox/private.ppk

Install on AWS, Google, Digital Ocean, etc

1. make sure your instance is running almalinux 8.x
2. clone repo in /var/www/modules
3. run install.sh

(back to top)

Usage

Tests

When running tests make sure that you have SSH into the vagrant box before proceeding with these steps.

1. CD into the modules directory

   cd /var/www/modules

2. Run pytest

   pytest

(back to top)

Other Deets

Architecture

The following bash output is the directory structure and organization of bento-box:

tree

.
├── generate_putty_key.bat
├── __init__.py
├── install.sh
├── LICENSE
├── provision
│   ├── dev_env.sh
│   ├── enable_ssl.sh
│   ├── logrotate.conf
│   ├── modules.sh
│   ├── nginx_conf
│   ├── nginx.sh
│   ├── packages.sh
│   ├── static.conf
│   └── tests.conf
├── README.md
├── root_app
│   ├── __init__.py
│   ├── root_app.conf
│   ├── root_app_conf_d.conf
│   ├── root_app.py
│   ├── root_app.service
│   ├── root_app.toml
│   ├── templates
│   │   ├── base_template.html
│   │   └── index.html
│   └── wsgi.py
├── static
│   ├── css
│   │   └── root.css
│   ├── favicon.ico
│   └── image
│       ├── android.png
│       └── product_screenshot.png
├── tests
│   ├── __init__.py
│   └── test_root_app.py
└── Vagrantfile
8 directories, 29 files

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

• John Zechlin
• Phx Devs
• Bento Reloaded

(back to top)