falkor

KO | EN

gitlite — search

#php #golang #ios #swift #javascript #dotfiles #macos #python #api #ruby #hacktoberfest #css

★ 85 Open GitHub ↗

Dive into Falkor, where you'll discover a vast selection of games coupled with community-driven enhancements. Experience seamless and secure gaming within a single, universal hub.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Falkor: Your Ultimate Gaming Hub

Dive into Falkor, where you'll discover a vast selection of games coupled with community-driven enhancements. Experience seamless and secure gaming within a single, universal hub.

Built with the cutting-edge technology of Electron and React, Falkor offers an unparalleled gaming experience that's fast, secure, and cross-platform.

## Features

As the project continues to evolve, we have an exciting lineup of features in development, including:

- Comprehensive tools to help you organize and manage your game collection effortlessly (W.I.P).
- An integrated torrent client for seamless game downloads (W.I.P).
- A release calendar to keep you updated on upcoming game launches.
- A powerful API that allows the community to create third-party plugins (currently limited to providers, but with plans to expand soon).
- And much more on the horizon...

Stay tuned—there’s plenty more to come!

## Getting Started

To get started with Falkor, follow these steps:

1. **Install Yarn**  
   Make sure Yarn is installed on your system. You can find installation instructions [here](https://classic.yarnpkg.com/en/docs/install).

2. **Install Dependencies**  
   In the project’s root directory, run `yarn install` to install all required dependencies.

3. **Configure Environment Variables**  
   Copy `.env.example` to `.env` and fill in the required values as described below.

4. **Start the Development Server**  
   Run `yarn dev` to launch the development server and enable real-time updates as you work.

---

### Environment Variables

#### IGDB (Twitch)

- `VITE_TWITCH_CLIENT_ID`: Your Twitch client ID.  
  See: ```IGDB Getting Started``` (https://api-docs.igdb.com/#getting-started)

- `VITE_TWITCH_CLIENT_SECRET`: Your Twitch client secret.  
  See: ```IGDB Getting Started``` (https://api-docs.igdb.com/#getting-started)

#### IsThereAnyDeal (ITAD)

- `VITE_ITAD_API_KEY`: Your IsThereAnyDeal API key.  
  See: ```ITAD API Access``` (https://docs.isthereanydeal.com/#section/Access)

#### Real Debrid (RD)

- `VITE_RD_CLIENT_ID`: Client ID for open source apps, as found in the Real Debrid documentation.  
  See: ```Real Debrid API``` (https://api.real-debrid.com/)

#### Steam

- `VITE_STEAM_API_KEY`: Your Steam API key, used for authentication and Steam API access.  
  See: ```Steam API Key``` (https://steamcommunity.com/dev/apikey)

### NixOS Flakes

```nix
# flake.nix

{
  inputs.falkor.url = "github:Team-Falkor/app";
  # ...

outputs = {nixpkgs, falkor, ...} @ inputs: {
    nixosConfigurations.HOSTNAME = nixpkgs.lib.nixosSystem {
      specialArgs = { inherit inputs; }; # this is the important part
      modules = [
        ./configuration.nix
      ];
    };
  }
}

# configuration.nix

{inputs, pkgs, ...}: {
  environment.systemPackages = with pkgs; [
    inputs.falkor.packages.${pkgs.system}.default
    # ...
  ];
}
```

## Contributing

We welcome contributions to Falkor! If you are looking for ways to contribute, here are some options:

- Assisting in writing and enhancing the documentation.
- Contributing code that you believe could enhance the project.
- Aiding in bug testing on pre-releases.
- Adding i18n translations for multiple languages.

If you're unable to assist with any of these, no worries! We simply appreciate your presence and support on this journey! 😄

## i18n Translations

We welcome you to contribute translations to Falkor! Here are some steps to help you get started with translating the app 😀

1. Navigate to the `src/i18n/translations` folder and duplicate the `en-US.json` file.
2. Translate all the values, ensuring that you keep the keys the same.
3. Go back to the `src/i18n` folder and open `index.tsx`. Import your new translation JSON file and add it to the `resources` object.

That's it! Thank you for helping make Falkor accessible to more users.

## Contributors

## Acknowledgments

- Built with [Electron](https://www.electronjs.org) and [React](https://react.dev/).

- All game data comes from the following APIs: [IGDB](https://www.igdb.com/), [ITAD](https://isthereanydeal.com/), and [Steam](https://store.steampowered.com/). We are not affiliated with any of these services; we simply utilize their APIs for data.

Thanks to everyone who helps us make this possible. A list of contributors can be found [here](https://github.com/team-Falkor/app/graphs/contributors).

<br />

# ❤️

Reminder that <strong><i>you are great, you are enough, and your presence is valued.</i></strong> If you are struggling with your mental health, please reach out to someone you love and consult a professional. You are not alone; there is a large range of resources online for support and guidance.

falkor

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README