Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/firestreaker2/osu-mirror

Simple mirror for osu made with qwik
https://github.com/firestreaker2/osu-mirror

mirror osu osu-api osu-mirror osugame qwik tailwind ts typescript

Last synced: about 1 month ago
JSON representation

Simple mirror for osu made with qwik

Awesome Lists containing this project

README

        

![osu-mirror](https://socialify.git.ci/FireStreaker2/osu-mirror/image?description=1&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Dark)

# About

osu-mirror is a simple osu! beatmap mirror made with [Qwik](https://qwik.builder.io/), [Tailwind](https://tailwindcss.com/), and [TypeScript](https://www.typescriptlang.org/). It utilizes an external api to retrieve info, and display it seemlessly online.

# Selfhosting

## Setup

```bash
$ git clone https://github.com/FireStreaker2/osu-mirror.git
$ cd osu-mirror
$ npm i
```

For development:

```bash
$ npm start
```

For production:

```bash
$ npm run build
```

## Deployment

Alternatively, you may also to deploy to [Vercel](https://vercel.com/).
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FFireStreaker2%2Fosu-mirror)

# Credits

- [osu!](https://osu.ppy.sh/)
- [chimu api](https://chimu.moe/docs)
- [Tailwind CSS Color Generator](https://uicolors.app/create)

# License

[MIT](https://github.com/FireStreaker2/osu-mirror/blob/main/LICENSE)