Skip to main content

Desktop App

Welcome to the miragek quote official desktop app documentation. This will guide on how to setup with or without coding.

MiraQuote Zip

What this doc contains?​

  • Installing with executable
  • By runnung from source code
Before you start

Please follow the executable process if you are not experienced with programming in general as well as Electron!

What to expect?​

  • A app that displays quotes on a small widgets in your scrren anywhere you go
  • A app that does let you fetch and replace boring quotes for offline
  • A app that does not bore you! You will get to learn everyday

MiraQuote Desktop Home

You can add to startup

Add the program to startup so that you don't need to open everytime. We did not add this feature by default because most people want full control and decides by themselves

Installing prebuilt binaries​

  1. Download a latest release for your system. For direct download, click here for windows and for linux, click here

  2. MiraQuotes does not come with an installer. You will need to manually extract the zip file to a location in your computer. Extract it there!

  3. Create a shortcut for the app to your Desktop/Home screen

  4. (optional) Add to startup

  5. Run the app to get started! That is it. Our app will follow you everywhere you go!

MiraQuote Desktop Home

You need api key to fetch update

Remember to replace test in the setting page to your api key. Please check the doc getting started sectiuon for more info

MiraQuote Desktop Home

Getting Started With The Code​

If you want to styart your own project or run from source code, you may read on!

  1. Prerequisites:
    • Strong understanding of programming in general
    • NodeJs, Nmp must be installed on your computer
  2. Installation:
  1. Note: If you download the source code from the release section, you would not need to run npm install for downloading other files. However, if you get the one in the main branch, you will need to first run npm install before npm start in the directory you have the project in.
  2. Bonus tip: We do not use any external or addtional package, nor dependency. Electron by default makes your app so big. Our main files might not even exceed 3mb.

MiraQuote Desktop Home

Building for Production​

  • Package your app for distribution:

    • We tried electron builder and it failed us severally. So, we suggest you follow this step which works for any project.

    • Download Electron Release: You should manually download the Electron release that matches your app's requirements.
    • Extracting: Next, extract the contents to a folder.
    • Renaming the Default Executable: You should rename the electron.exe or whatever to your desired app name.
    • Modifying Resources: You need to go to resource folder, delete the default app (default_app.asar), create a folder called app and copy inside eveything from your modified app root such as index html, node folder and everything else.
    • That is all! Run the executable now!
    • We also tried to use Ino Setup to create an installer for windows, but it didn't work and we don't know why.

Development​

  • Debugging:
    • Use your IDE's debugging tools or Electron's built-in debugger.
  • Hot Reloading:
    • Configure your development environment for automatic reloading when code changes.
    • Consider using tools like nodemon or electron-reload.

Contributing​

  • Welcome contributions!
  • Guidelines for contributing:
    • Fork the repository.
    • Create a new branch.
    • Make your changes.
    • Submit a pull request.

Please educated yourself more if you are a newbie. We also recommend this-> https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork

Built With​

  • The core technologies:
    • Electron
    • Frontend (html, css, javascript)
    • Backend technologies (Non, just MiraQuote API)

Miragek Quote Desktop Github

License​

  • You are free to call it a CC0 but we must be respected for our service
    • MIT License

Additional Information​

  • This app requires an active MiraQuote api key
  • In next updates, we might move from Electron
  • Please send us a message if you are open to contributing in any way

Remember this is made to see how far we can go with our great api