HCI Discipline Final Project

A simple Front End interface simulation

About this project

The Human Computer Interface discipline final pratical project of Federal University of Lavras (UFLA). It's a simple front end interface with costumer requirements and some features as accessibility and usability tests.

Geting Started

You will need to install all system requirements to edit and change any parts of this project. The following are listed all requirements.

System Requirements

Shell Bash
Ruby
SASS
NPM
PUG

How to use

In first step, enter the directory:

$ cd HCI-Front-End-Project/

Continuing then, to edit the page structures style, you need to access the SASS directory:

$ cd src/ext/sass

If you want to change any html structures, then you need to access the PUG directory:

$ cd src/ext/pug

After that, you will need to compiler the changes to output the .html and .css files, automatically. To do this, you can:

$ cd HCI-Front-End-Project/
$ ./compile_sass.sh
or
$ ./compile_pug.sh

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

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

Control Task List

The poject tasks that should be developed.

Project Customer

This project was developed as study project. There isn't customer.

Authors

Felipe Palmuti - Computer Science student of Federal University of Lavras - [email protected]
Lucas Fiorini Braga - Computer Science student of Federal University of Lavras - [email protected]
Lucas Fonseca dos Santos - Computer Science student of Federal University of Lavras - [email protected]
Marco Aurélio Ferreira de Sousa - Computer Science student of Federal University of Lavras - [email protected]

License

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

lucasfonsecadossantos / hci-front-end-project Goto Github PK

hci-front-end-project's Introduction