Skip to content

Latest commit

 

History

History
160 lines (121 loc) · 4.49 KB

README.md

File metadata and controls

160 lines (121 loc) · 4.49 KB
Raw

Project name

Loruki WebSite

Table of contents

  • Project name
  • General info
  • Screenshots
  • Technologies
  • Configuration
  • Code examples
  • Features
  • Status
  • Inspiration
  • Contact
  • Instructions for use
  • Code quality checks
  • Continuous integration
  • Repository setup

Name of our project

Loruki is a website offering cloud services

General info

  1. Home
  2. Features
  3. Docs

Screenshots

Sample screenshot Sample screenshot Sample screenshot

Technologies

  1. HTML
  2. CSS
  3. Grid
  4. Flexbox
  5. Node 14.16.0
  6. JavaScript
  7. VSC code

Configuration (set up)

Installation

  • npm run start
  • npm run build

A guide to using source repository

  1. git clone [email protected]:HackYourFutureBelgium/template-markdown.git
  2. cd template-markdown
  3. npm install

Code quality checks

  • npm run format: Make sure all the code in this repository is formatted correctly (looks good). (looks good).
  • npm run lint:ls: Checks that all the folder and file names match the conventions of the repository.
  • npm run lint:md: Checks all Markdown files in this repository.
  • npm run lint:css: Will make a copy of all CSS files in this repository.
  • npm run validate:html: Validates all HTML files in your project.
  • npm run spell-check: Goes through all the files in this repository looking for words it doesn't recognize. Just because it says something is an error does not mean it is! It doesn't know every word in the world. You can add new correct words to the ./.cspell.json file so that they do not cause an error. an error.
  • npm run accessibility -- ./path/to/file.html: Runs an accessibility scan on all HTML on all HTML files in the given path and writes the report to the file /accessibility_report file.

Continuous Integration (CI)

When you open a PR to main/master in your repository, GitHub will automatically do a linting check on the code in that repository, you can see this in the this in the file github/workflows/lint.yml.

If the linting fails, you will not be able to merge the PR. You can check that your code will that your code will pass before pushing it by running the code quality scripts locally.

Repo configuration

  • Give each member written access to the repo (if it's a group project).
  • Enable GitHub pages and put a link to your website in the repo description.
  • Activate the GitHub Actions
  • in the Branches section of your repo settings, make sure :
    • The repository requires review before pull requests can be merged.
    • The master/main branch must "Require status checks to pass before merge"
    • The master/main branch must "Require required branches to be up to date before merging"

Code examples

//
<!-- NAVBAR -->
          <div class="navbar">
              <div class="container flex">
                  <h1 class="logo">Loruki.</h1>
                      <nav>
                           <ul>
                               <li><a href="index.html">Home</a></li>
                               <li><a href="features.html">Features</a></li>
                               <li><a href="docs.html">Docs</a></li>
                           </ul>
                      </nav>
              </div>
          </div>

Features

List of ready features and Todos for future development

List of things to do

Status

The project is: in progress

Inspiration

Loruki WebSite HYF Template for HTML and CSS

Contact

HYF-Class19-Group2

Group Members

Name GitHub Links
Anita Sharma AnitaSharma2022
Helen Helen-HYF
John Olutubo JohnOlutubo
Michael Mugaiga MichaelMugaiga
Renjani renjani2022
Thomas Ayissi thomas-ayissi

How to use