https://github.com/jd-apprentice/easy-static
🧰 simple static site deployment tool
https://github.com/jd-apprentice/easy-static
Last synced: 14 days ago
JSON representation
🧰 simple static site deployment tool
- Host: GitHub
- URL: https://github.com/jd-apprentice/easy-static
- Owner: jd-apprentice
- License: apache-2.0
- Created: 2023-09-10T23:43:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-29T01:45:39.000Z (over 2 years ago)
- Last Synced: 2025-06-12T19:39:19.902Z (8 months ago)
- Language: HCL
- Size: 782 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# easy static - static site deployment tool
Manage your static site with ease. Easy Static is a simple static site deployment tool that allows you to deploy your static site to multiple hosts with a single command.
# Table of Contents
1. [Design 🖌](#design-)
2. [Software requirements 📦](#software-requirements-)
3. [File structure 📁](#file-structure-)
4. [Documentation 📕](#documentation-)
5. [License 📰](#license-)
## Design 🖌
## Software requirements 📦
For local development
- [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
- [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli)
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
- [jq](https://stedolan.github.io/jq/download/)
- [pip](https://pip.pypa.io/en/stable/installing/)
For application usage with ease
- [Docker](https://docs.docker.com/engine/install/)
AppImage
- Soon...
## Documentation 📕
Build example
```bash
make build -f docker.mk image_name="easy-static"
```
Run command example
```bash
make run -f docker.mk image_name="easy-static" command="start" action="output" environment="dev"
```
## File structure 📁
```
🌳 easy-static/
┣ 📁 ansible/
┃ ┣ 📁 files/
┃ ┃ ┗ 📄 .gitkeep
┃ ┣ 📁 inventory/
┃ ┃ ┗ 📄 .gitkeep
┃ ┣ 📁 playbook/
┃ ┃ ┗ 📄 .gitkeep
┃ ┗ 📄 .gitkeep
┣ 📁 app/
┃ ┗ 📁 Boilerplate/
┣ 📁 design/
┃ ┣ 📄 .gitkeep
┃ ┗ 📄 easy-static-new.png
┣ 📁 docs/
┃ ┗ 📄 .gitkeep
┣ 📁 scripts/
┃ ┣ 📄 .gitkeep
┃ ┣ 📄 install-ansible.sh
┃ ┣ 📄 install-docker.sh
┃ ┣ 📄 install-terraform.sh
┃ ┣ 📄 run.sh
┃ ┗ 📄 s3-action.sh
┣ 📁 terraform/
┃ ┣ 📁 .terraform/
┃ ┃ ┣ 📁 modules/
┃ ┃ ┃ ┗ 📄 modules.json
┃ ┃ ┗ 📁 providers/
┃ ┃ ┗ 📁 registry.terraform.io/
┃ ┃ ┃ ┗ 📁 hashicorp/
┃ ┣ 📁 config/
┃ ┃ ┣ 📄 dev.tfvars
┃ ┃ ┗ 📄 prod.tfvars
┃ ┣ 📁 modules/
┃ ┃ ┗ 📁 s3/
┃ ┃ ┣ 📄 output.tf
┃ ┃ ┣ 📄 provider.tf
┃ ┃ ┣ 📄 resources.tf
┃ ┃ ┗ 📄 variables.tf
┃ ┣ 📄 .gitkeep
┃ ┣ 📄 .terraform.lock.hcl
┃ ┣ 📄 main.tf
┃ ┣ 📄 terraform.tfstate
┃ ┣ 📄 terraform.tfstate.backup
┃ ┗ 📄 versions.tf
┣ 📄 .gitignore
┣ 📄 .gitmodules
┣ 📄 Makefile
┗ 📄 README.md
```
## License 📰
You can check the license at [LICENSE](./LICENSE)