Skip to content

Commit

Permalink
common: added README
Browse files Browse the repository at this point in the history
  • Loading branch information
clementlize committed Aug 25, 2023
1 parent fb0ea85 commit 58aa07a
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Firestore fullscreen (Chrome extension)

Get a fullscreen experience when browsing the Firestore database.

Have you ever spent time browsing the firestore database and wondered why the 3 columns section had to be on such a small screen area?
This extension adds a button in the interface which toggles fullscreen mode. When in fullscreen mode, the 3 columns table takes the whole screen area so that you can browse easily. Click again on the button to exit the fullscreen mode and get back to normal.

No data is read or collected, the extension only adds the button and changes some CSS properties.
Full source code is available here: https://github.com/clementlize/firestore-fullscreen

## Screenshots

![Before (screenshot)](./docs/screenshots/before.jpg)
![After(screenshot)](./docs/screenshots/after.jpg)

## Installation

### From the Google Chrome Web Store

Go to the [Chrome Web Store extension page](https://chrome.google.com/webstore/detail/firestore-fullscreen/gemkoopkmgjeegmkoceojgflbpfibnbb) and install it.

### Locally

You can use your own local version of the extension. To do so, follow these steps:

- Clone the project in a dedicated directory on your computer
- Open the Chrome extensions page (chrome://extensions/)
- Enable the "Developer mode" (top right corner)
- Click on "Load unpacked" (top left corner)
- Select the directory where you cloned the project

More information here: [Chrome Extension development basics](https://developer.chrome.com/docs/extensions/mv3/getstarted/development-basics/).

## Contribute

Contributions are always welcome! Feel free to open an issue if you want to report a bug or ask for a feature. Don't forget to search for an existing issue before creating one.

If you're a developer and you want to add/edit code, feel free to open a merge request.

Learn more here: [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)

## License

This project is licensed under GNU GPL v3. See the LICENSE file in the repository for more information.
Binary file added docs/screenshots/after.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/before.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 58aa07a

Please sign in to comment.