Easy Architecture

A simple bash shell script for static Front-End web interface base generation.

About this project

This script initialize and creates all project directories and verifys if all dependencies are installed to develop any web front end project.

Geting Started

Coming soon

System Requirements

Shell Bash
Npm
Pug
Sass
Wget
Unzip

How to use

In first step, enter the directory:

$ cd Easy-Architecture/

Continuing then

$ sudo chmod +x init.sh compile_sass.sh compile_pug.sh
$ ./init.sh <project_name> <project_path> <style_architecture>

Where the project_name is your project name rs. The project directory will be created in:

$ <project_path>/project_name

Where project path is your main directory. For access the project:

$ <project_path>/project_name

Execute the SASS and PUG compiler

In project directory

<project_path>/project_name

execute the following bash scripts:

$ ./compile_sass.sh

and to execute the PUG compiler, you have to open another bash or terminal emulador and you need to execute the other bash script:

$ ./compile_pug.sh

Project Structure

cooming soon

Directories List

Directory Name	Content
docs	Storages all generated documentations.

File List

Class Name	Function	Header File
Master	The master turbo fire version.	app/master.hpp

Version Control Documentation

This topic explains how the project version control in this repository works.

Sign List

Commit type	Sign
Initial commit	🎉 `:tada:`
Version tag	🔖 `:bookmark:`
New feature	✨ `:sparkles:`
Bugfix	🐛 `:bug:`
Metadata	📇 `:card_index:`
Documentation	📚 `:books:`
Documenting source code	💡 `:bulb:`
Performance	🐎 `:racehorse:`
Cosmetic	💄 `:lipstick:`
Tests	🚨 `:rotating_light:`
Adding a test	✅ `:white_check_mark:`
General update	⚡ `:zap:`
Improve format/structure	🎨 `:art:`
Refactor code	🔨 `:hammer:`
Removing code/files	🔥 `:fire:`
Continuous Integration	💚 `:green_heart:`
Security	🔒 `:lock:`
Upgrading dependencies	⬆️ `:arrow_up:`
Downgrading dependencies	⬇️ `:arrow_down:`
Lint	👕 `:shirt:`
Translation	👽 `:alien:`
Text	📝 `:pencil:`
Critical hotfix	🚑 `:ambulance:`
Deploying stuff	🚀 `:rocket:`
Fixing on MacOS	🍎 `:apple:`
Fixing on Linux	🐧 `:penguin:`
Fixing on Windows	🏁 `:checkered_flag:`
Work in progress	🚧 `:construction:`
Adding CI build system	👷 `:construction_worker:`
Analytics or tracking code	📈 `:chart_with_upwards_trend:`
Removing a dependency	➖ `:heavy_minus_sign:`
Adding a dependency	➕ `:heavy_plus_sign:`
Docker	🐳 `:whale:`
Configuration files	🔧 `:wrench:`
Package.json in JS	📦 `:package:`
Merging branches	🔀 `:twisted_rightwards_arrows:`
Bad code / need improv.	💩 `:hankey:`
Reverting changes	⏪ `:rewind:`
Breaking changes	💥 `:boom:`
Code review changes	👌 `:ok_hand:`
Accessibility	♿ `:wheelchair:`
Move/rename repository	🚚 `:truck:`
Other	Be creative
Standart documentation based on: Emoji List

How to Contribute

Authors

Lucas Fonseca dos Santos - Computer Science student of Federal University of Lavras - [email protected]

License

This project is licensed under no license. Copyleft is freedom!

lucasfonsecadossantos / easy-architecture Goto Github PK