Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.6 KB

README.md

File metadata and controls

38 lines (28 loc) · 2.6 KB
Raw

osu.place Link

Easily connect osu! accounts to your Discord server!

osu.place Link is a Discord third-party app that provides a Linked Role connection to allow you to link your osu! account to Discord, use it as a requirement for a Linked Role, and show it on your Server Profile.

If you're looking to use this in your own Discord server, you don't need to host it yourself! Just visit link.osu.place and add it to your server, then add a linked role.

Installation + Development

  1. git clone --recurse-submodules https://github.com/osuplace/link && cd link
  2. Build Auth.js:
    1. cd auth.js
    2. pnpm install && pnpm build
    3. This is gonna take like 5 minutes so go get a snack in the meantime :3
    4. Change all the dependencies that use workspace: in packages/frameworks-express and packages/adapter-prisma to use file: relative paths instead (i.e. file:../core).
  3. yarn install (install dependencies)
  4. Copy .env.example to .env and edit .env to configure the app
  5. Set up the database:
    • In development, use yarn db:dev to generate the Prisma client and deploy the schema to your local database.
      1. If you make changes to the Prisma schema, run yarn db:dev again to regenerate the client and deploy the changes to your local database
      2. Then, before committing changes that modify the database schema, use yarn db:commit to generate migration files
      • Remember, you can use yarn db:studio to open Prisma Studio, a GUI to view and edit the database.
    • In production, use yarn db:prod to generate the Prisma client and deploy the migration files.
  6. yarn build (compile TypeScript)
    1. You might see some errors within @auth, but those don't actually affect anything for us, so just ignore them.
  7. yarn register (registers role metadata with Discord)
  8. yarn start

License & Copyright

Copyright (c) 2024 April [email protected]

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.