Skip to content

codesprut/giftseeker

Repository files navigation

GiftSeeker

App for automatically participate in raffles on different websites.
Program developed like a Node.js application. Electron used for UI only.

Supported websites
  • steamgifts.com
  • indiegala.com
  • opiumpulses.com
  • astats.nl

Setup

If you are an end user, you can download and install application directly from our website Download Section.

Quick start

Make sure you have Node.js >= 14.15.3 installed, then type the following commands.

  1. git clone https://github.com/codesprut/giftseeker.git
  2. cd giftseeker
  3. npm install
  4. npm run start:ui or npm run start:cli

Now you have a running desktop or cli application on your screen.

Structure of the project

The application located in the src directory which consists of the following main folders:

  • core - node.js modules with main app features.
  • modules - useful independent modules. For example, a storage module.
  • electron - serves as the app UI using the APIs provided by app modules.
  • console - cli program implementation.
  • resources - contains common static files.

Testing

Run all tests:

npm run test

Build

We use electron-builder module to build our application.

Use follow commands to build the app:

Package in a distributable format (e.g. dmg, Windows installer, deb package)

npm run dist:mac
npm run dist:win
npm run dist:linux

The build process compiles the content of the src and node_modules directories.

Feedback

Any questions or suggestions?

Here's a list of different ways to me and request help:

Support - help us to grow ;)

Contributing

Contributions are always welcome!

By participating in this project you agree to abide by contributor code of conduct terms.

License

MIT ©