Skip to content

Commit

Permalink
Rename project title and add more information about version 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcelo-earth
marcelo-earth committed Dec 19, 2022
1 parent 2c51cad commit 3673317
Showing 1 changed file with 60 additions and 36 deletions.
96 changes: 60 additions & 36 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,97 +1,121 @@
<p align="center">
<img
src=".github/PlatziKeyIcon.png"
src=".github/PlatKeyIcon.png"
align="center"
width="100"
alt="PlatziKey"
title="PlatziKey"
alt="PlatKey"
title="PlatKey"
/>
<h1 align="center">Platzikey</h1>
<h1 align="center">PlatKey</h1>
</p>

<p align="center">🚀 Give awesome features to your <a href="https://platzi.com">Platzi Exams</a> with this browser extension 🦉.</p>
<p align="center">🚀 Awesome features to your <a href="https://platzi.com">Platzi Exams</a> with this browser extension 🦉.</p>

<a href="https://github.com/360macky/platzikey/blob/main/INSTALLATION.md">
<p align="center">💚 Open Source, Free, and available for Chrome, Edge, Brave, Arc and Safari 🦁</p>

<p align="center">
<img
src=".github/BannerInstallation.png"
src=".github/preview.gif"
align="center"
width="300"
alt="Preview of PlatKey"
title="Preview of PlatKey"
style="border-radius: 10px"
/>
</a>
</p>

<p align="center">
🤗 Thank you for visiting this browser extension project, help spread it by giving a star! 🌟<br />
<br />
<a href="https://github.com/360macky/platzikey/stargazers"><img src="https://img.shields.io/github/stars/360macky/platzikey?label=Star%20this%20repository%21&style=social" /></a><br />
<a href="https://github.com/360macky/PlatKey/stargazers"><img src="https://img.shields.io/github/stars/360macky/PlatKey?label=Star%20this%20repository%21&style=social" /></a><br />
</p>

## 💻 Development
## 🤖 Concept

PlatziKey is an extension targeting Chromium-based browsers like Chrome, Edge, and Brave. The main feature is to provide shortcuts (or hotkeys) to access the options of a Platzi exam, speeding up the process of choosing an answer to a question, and improving the experience of users who want to interact more with the keyboard than with the mouse.
**PlatKey** is a browser extension that helps you to solve exams faster in Platzi. And also the extension provides new functionalities to improve the experience of taking classes in Platzi.

### 🔭 Control Flow
Briefly the features of PlatKey are:

The `content.js` file is executed in background everytime the page is loaded for the `"https://platzi.com/*"`

PlatziKey works with these permissions:
- **Shortcuts**: Select exam options faster with your own keyboard shortcuts. Also navigate between classes and make contributions using keyboard shortcuts.
- **Greenboard**: Open a fully integrated _whiteboard_ in your exam.
- **Zen Mode**: A new design that reduces the number of buttons and visual elements in the exam.
- **SSH Mode**: A terminal-style design to solve exams as if you were installing a package.
- **Highlight classes**: Select classes you want to highlight in your Student Home.
- **Save contributions**: Save contributions in your Student Home.
- **Spotlight**: A new design for the search bar of Platzi available with a keyboard shortcut.

* `storage`: To store variables like `shortcuts`, `greenboard`, etc.
* `scripting`: To execute JavaScript scripts inside the page itself.

### ⌨️ Shortcuts Technology

To achieve this, PlatziKey [creates an eventlistener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) inside window to listen for keypresses on keys `A`, `B`, `C`, `D`, `E` and `1`, `2`, `3`, `4`, `5` and `6`. Also `X` or `0` key to skip the question.
It supports chromium-based browsers (like Chrome, Edge, Brave, Arc) and WebKit-based browsers (like Safari).

## 🚀 Features

### ⌨ PlatziKey Shortcuts
Things you can do with **PlatKey**:

### ⌨ PlatKey Shortcuts

Select exam options faster with your own keyboard. Use letters, and numbers!

### 🖌 PlatziKey Greenboard
### 🖌 PlatKey Greenboard

Open a fully integrated _whiteboard_ in your exam to be able to draw, do calculations or whatever you want.

### 🧐 PlatziKey Zen Mode
### 🧐 PlatKey Zen Mode

A new design that reduces the number of buttons and visual elements in the exam.

### 💻 PlatziKey SSH Mode
### 💻 PlatKey SSH Mode

A terminal-style design to solve exams as if you were installing a package.

### New features 👀

The verision 3 of PlatKey will come with new features soon...
The version 3 of PlatKey will come with new features soon...

## 🏛️ History
## 💻 Core Development

This browser extension was made with the motive of **accelerating the speed of exam taking** in Platzi inspired by the way in which Typeform structures the shortcuts of its forms.
PlatKey has a software architecture targeted to be a browser extension for the Chrome Web Store. Since version 3.0 PlatKey adds support for Safari.

Keys were extended to not just letters (A, B, C...), but numbers (1, 2, 3). Then the whiteboard functionality was added for **drawing within the exam**, I called it **Greenboard**.
PlatKey does not store information of the users. An account is not required to use the extension.

Finally two additional web themes to touch up the appearance of the exam.
Information related to their extension preferences is stored in the browser's storage.

**Zen Mode** is the name that many applications use for the _concentration_ mode that **reduces visual elements in the graphical interface**. We use it here as Zen Mode as well.
### 🔭 Control Flow

**SSH Mode** is a theme **inspired by the default terminal design**. A design similar to the command line interface of installing packages with Python, or initializing a project with ESLint.
The `popup.html` file is the extension window. The `popup.js` file is the JavaScript code whose scope is in this window. It executed when the popup es opened.

The `background.js` file only contains the default storage information about the features of PlatKey.

The `content.js` file is executed in background everytime the page is loaded for the `"https://platzi.com/*"`

PlatKey works with these permissions:

- `storage`: To store variables like `shortcuts`, `greenboard`, etc.
- `scripting`: To execute JavaScript scripts inside the page itself.

### ⌨️ Shortcuts Technology

PlatKey [creates an eventlistener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) inside window to listen for keypresses on keys `A`, `B`, `C`, `D`, `E` and `1`, `2`, `3`, `4`, `5` and `6`. Also `X` or `0` key to skip the question.

## 🔩 Installation

### 🚅 Production (recommended)

Go to [PlatziKey Extension page](https://chrome.google.com/webstore/detail/platzikey/bdjedpeffgjikndcihipemgdinpcmpcf?hl=es-419), and click on "Add extension".
Go to [PlatKey Extension page](https://chrome.google.com/webstore/detail/PlatKey/bdjedpeffgjikndcihipemgdinpcmpcf?hl=es-419), and click on "Add extension".

It works correctly in Google Chrome, Micorosft Edge and Brave.

## 🏛️ History

This browser extension was made with the motive of **accelerating the speed of exam taking** in Platzi inspired by the way in which Typeform structures the shortcuts of its forms.

### 🦊 Development

If you want the latest features of PlatziKey you can install the development version following [this tutorial](https://github.com/360macky/platzikey/blob/main/INSTALLATION.md).
If you want the latest features of PlatKey you can install the development version following [this tutorial](https://github.com/360macky/PlatKey/blob/main/INSTALLATION.md).

## 🤲 Contributing

Do you would like to contribute? Do you want to be the author of a new feature? Awesome! please fork the repository and make changes as you like. [Pull requests](https://github.com/360macky/platzikey/pulls) are warmly welcome.
Do you would like to contribute? Do you want to be the author of a new feature? Awesome! please fork the repository and make changes as you like. [Pull requests](https://github.com/360macky/PlatKey/pulls) are warmly welcome.

Also, you can check [Issues](https://github.com/360macky/platzikey/issues) to get any ideas on how to improve this browser extension.
Also, you can check [Issues](https://github.com/360macky/PlatKey/issues) to get any ideas on how to improve this browser extension.

## 📃 License

Expand Down

0 comments on commit 3673317

Please sign in to comment.