💫 ALX Intranet Extension 💫

_{(Screenshot from v0.2.2)}

Tutorial Video (arabic / darija): https://youtu.be/WxMfN6YxmDs

🎛️ Features

Initial Files and Directories:
Provides you with a command that includes all the files and directories trees of the tasks.
Simply copy and paste the command into your terminal

Task Navigation:
Scroll to your desired task with ease using the keyboard shortcut.

Checker Control:
Select checks you want to run. Also Get feedback on which tasks have failed or succeeded.
( Please try keep servers healthy 💚 by only running the checks you need )

Easy Quiz:
You dont have any more keep scroll down and up to correct you ansewrs,
allows you to easily review and change your responses

Collapse Tasks:
Allows to collapse individual tasks or all successful/failed tasks at once

User Style:
fully customize the styling of your intranet page

🧩 Installation

There are several ways to install the extension:

Chrome Web Store: You can install the extension directly from the Chrome Web Store. Updates may be delayed by ~2 days due to the store review process.
Release Assets: You can download the ZIP file from the Release Assets and extract it to a folder on your computer. Then,
- Open your browser and navigate to the extensions page (chrome://extensions for Chrome or edge://extensions for Edge).
- Enable developer mode by toggling the switch in the top right corner of the extensions page.
- Click on the Load unpacked button and select the folder where you extracted the extension files.
- The extension should now be installed and ready to use!
Build from Source: Requires Node.js >16.6 or >18 and either yarn (recommended) or npm. Run yarn install followed by yarn build. After, you will have a dist folder. Follow the previous instructions in the "Release Assets" to install the extension from the dist folder.

⚙️ Usage

Initial Files and Directories:
Click [Tasks] button, and paste the command in your terminal, then click Enter
Task Navigation:
Press the number keys on your keyboard to navigate to the corresponding task. For example, pressing the 1 key will scroll the page to task 1.
To navigate to a task with a two-digit number, hold down the Shift key while pressing the number keys. For example, to navigate to task number 12, hold down the Shift key and press the 1 key followed by the 2 key.
Checker Control, Easy Quiz, Collapse Tasks:
The user interface is simple and self-explanatory
User Style:
Go to extension settings ( click the top-right icon in popup )

🛡️ Privacy and Policies

Privacy

Our extension is designed to be offline-first, meaning that it does not rely on any external servers or backdoors.
We do not collect any personal data from our users. The only data we have access to is provided by Google Analytics, which shows us information such as the number of installs and uninstalls.

Policies

The purpose of our extension is to improve the user experience on the intranet. It is not intended to help users break any rules.
If someone from the staff of the ALX SE notices something that is not in line with their rules, they can contact us and we will take appropriate action.

We are committed to providing a safe and enjoyable experience for all users.

❤️ Contributing

As an open-source project, contributions are welcome and appreciated! If you would like to contribute, please kindly follow these steps:

Fork the repository on GitHub.
Clone your forked repository to your local machine.
Create a new branch for your changes.
Make your changes and commit them to your branch.
Push your changes to your forked repository on GitHub.
Open a pull request from your forked repository to the original repository.

If you have any questions or need help with the contribution process, feel free to open an issue on the project’s GitHub repository or Discord: Bio#2408

🚀 Feedback

Report a bug ➡️ GitHub Issue > Bug Report.
Request a feature ➡️ GitHub Issue > Feature Request.
Chit Chat ➡️ Discord Server
Form ➡️ Google forms

Solomonkassa/intranet-chrome-extension