Technical Documentation

We define our technical guidelines, information, and decisions here.

Coding Conventions

• Java Script Style Guide
• We use BEM for meaningful tags. This video is also very helpful.
• Use self-explaining codes: meaningful class, function, and variable names.
• Only use comments to describe the reason behind your code. Not the obvious.

Project Structure

root
├── assets # Include art files like fonts, images, etc
├── components
├── pages
├── scripts
├── styles
├── components.js
├── global.css
└── index.html

Technology Stack

What frameworks, tools, and technologies we use for our project.

• Pure HTML, CSS, and JavaScript.
• Git and GitHub for version control.

Git Flow

Testing

Test cases and tools...

Deployment & Infrastructure

How to build and deploy our website...