mirror of
https://github.com/Drop-OSS/drop.git
synced 2025-11-15 09:11:21 +10:00
47 lines
2.8 KiB
Markdown
47 lines
2.8 KiB
Markdown
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/Drop-OSS/media-sources/refs/heads/main/drop.svg" width="400rem"/>
|
|
</div>
|
|
<div align="center">
|
|
<a href="contributing.md">Contribution guide</a>
|
|
<a href="https://deepcore.dev">Our website</a>
|
|
</div>
|
|
<br>
|
|
<br>
|
|
|
|
[](LICENSE)
|
|
|
|
[](https://discord.gg/ZVGggfXN)
|
|
[](https://github.com/Drop-OSS/drop/blob/main/README.md)
|
|
|
|
|
|
# Drop
|
|
Drop is an open-source game distribution platform, like GameVault or Steam. It's designed to distribute and shared DRM-free game quickly, all while being incredibly flexible, beautiful and fast.
|
|
|
|
## Philosophy
|
|
1. Drop needs to be flexible. If you look at the code base, there are lots of interfaces and abstractions and generic classes. While these do make Drop a bit heavier, they create the much needed flexibility, modularity and future-proofing that Drop needs.
|
|
2. Drop needs to be secure. Always have security in mind when designing new features for Drop.
|
|
3. Drop needs to be user-friendly. Follow good design principles, and don't overload the user with too much information at once. Balance hiding things between menus and showing it all at once.
|
|
|
|
## The Tech Stack
|
|
This repo uses the Nuxt 3 + TailwindCSS stack, with the `yarn` package manager.
|
|
|
|
For the database, Drop uses Prisma connected to PostgreSQL.
|
|
|
|
## Development
|
|
To get started with development, you need `yarn --optional` and `docker compose` installed (or know how to set up a PostgreSQL database).
|
|
|
|
### Note: `--optional` flag is **REQUIRED**
|
|
Drop uses a utility package called droplet that's written in Rust. It has builts for Linux (GNU) and Windows, and they are set up as optional packages. `npm` installs these by default, but `yarn` needs the `--optional` flag.
|
|
|
|
Steps:
|
|
1. Copy the `.env.example` to `.env` and add your GiantBomb metadata key (more metadata providers coming)
|
|
2. Create the `.data` directory with `mkdir .data`
|
|
3. Ensure that your user owns the `.data` directory with `sudo chown -R $(id -u $(whoami))`
|
|
4. Open up a terminal and navigate to `dev-tools`, and run `docker compose up`
|
|
5. Open up another terminal in the root directory of the project and run `yarn` and then `yarn dev` to start the dev server
|
|
|
|
To create an account:
|
|
Head over to the `/register` page. It's currently a temporary development form for creating a username + password log in.
|
|
|
|
## Contributing
|
|
Please see the [in-depth contributing guide](https://github.com/Drop-OSS/drop/blob/main/CONTRIBUTING.md) |