emadhajjar / ontop-poke

OntopPoke

This is the repository for the Ontop Technical Challenge for Front End Engineers.

Table of contents

• OntopPoke
  • Table of contents
  • Documentation
  • Getting Stated
    • Installation
    • Start up the Dev Server
  • Tools
    • Git hooks
    • Docker
    • Homebrew
    • Volta.js
    • Chrome
  • Merge Requests
  • Tips
    • Create a branch from the latest main
      • Rebasing your brach onto latest main
  • Environments
  • Helpful Resources

Documentation

This README file includes basic information to help you get started on the project.

There are lots of things that still need to be documented. If you have any suggestions, feel free to submit a Merge Request or discuss with the team! Improvements are always welcome.

Getting Stated

Installation

1. It's recommended to have Docker, Homebrew and Volta installed.
2. Run yarn to download and link all dependencies.
3. Run yarn build to build all workspace packages.

Start up the Dev Server

1. Run yarn start to build all packages and start the development server.
2. Go to http://localhost:4200

Tools

Git hooks

We have a few hooks setup with Husky:

• pre-commit: Runs Prettier and ESLint using lint-staged before finishing a commit. If Eslint throws and error, the commit is aborted.

Docker

Docker is a platform designed to help developers build, share, and run container applications. We handle the tedious setup, so you can focus on the code.

To install Docker Desktop, checkout out the official Download Docker Desktop

Homebrew

Homebrew installs the stuff you need that Apple (or your Linux system) didn’t.

To install Homebrew run /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Volta.js

Volta.js makes it easier to manage Node tooling versions. If you have Volta.js installed you'll automatically use the correct Node and Yarn versions for this Project in your terminal, just by being in the project folder.

This is defined by the volta field in the root package.json

To install Volta, run curl https://get.volta.sh | bash or you can check out the official getting started documentation

Chrome

We need to have Chrome installed in order to run yarn test.

To install Chrome, checkout out the official Download Chrome

Merge Requests

Merge Requests are a great way to share knowledge about the codebase between the team and to increase the code quality. But in order to be helpful. they need to follow a few principles:

Some principles are:

1. Write your Merge Requests (MR) as if they are going to ready by other people.
2. Always write a descriptive and meaningful MR description.
3. Keep your MR as short and scoped as possible.

Tips

Create a branch from the latest main

Just run git checkout -b new-branch-name origin/main. if you use Zsh with the git plugin installed, you can replace git checkout -b with gcb.

Example: git checkout -b feat/some-feature origin/main.

Rebasing your brach onto latest main

You can run git pull --rebase origin/main. That way the latest main will be fetched.

Another options is to update the main branch to it's latest version and then run git rebase main

Environments

Environment	URL
staging	http://...

Helpful Resources

• Angular CLI