Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/flipper-xfw/xtreme-website

Source-code for our website
https://github.com/flipper-xfw/xtreme-website

Last synced: 2 months ago
JSON representation

Source-code for our website

Awesome Lists containing this project

README

        

Source-code for our website flipper-xtre.me

### Structure:

This project is structured into two folders:

1. [Public](https://github.com/Flipper-XFW/Xtreme-Website/tree/main/public):

The `public` folder is what you see when visiting the website. Its the compiled files for the webupdater & asset packs, and all the other things like HTML, CSS, JS.

2. [src](https://github.com/Flipper-XFW/Xtreme-Website/tree/main/src):

The `src` folder contains the raw source-code for the webupdater & asset pack page. This is intended for developers only.

### How does this all work?

Well, the core part is just HTML. Nothing fancy. Whats complicated is the webupdater & asset-packs page, as those use [Vue](https://github.com/vuejs/). In simple terms, Vue combines html and JS into a single file, allowing for a simpler build process of complex sites.

1. To compile the webupdater & asset-packs page, you first need to install all dependencies:

- For fedora:
```console
dnf install tzdata npm
```
- For Ubuntu:
```console
apt install tzdata npm
```
- For alpine:
```console
apk install tzdata npm
```

2. To then build, run these commands in the `frontend` directory:
```console
npm i
# If there is any vulnerabilities ALWAYS run "npm audit fix". Dont be lazy!
quasar build -m spa
```

3. Finally, just copy the built files over into the `public` folder. Yes, thanks to their randomized naming scheme that is kind of annoying but its not too bad. Then just serve it with a simple http server for testing, and put behind apache2 / nginx for production.

- Python http:
```console
python -m http.server
```



-----

## ❤️ Support
If you like what you're seeing, **please consider donating to us**. This will allow us to dedicate more time to the project(s) you love!

- **[Patreon](https://patreon.com/crazyco) (Fee: 8%\*)**: ❤️ Account needed, subscription with perks
- **[ko-fi](https://ko-fi.com/crazyco) (Fee: 2%\*)**: No account needed, subscription or one-time donation
- **[Wire-transfer](https://bunq.me/ClaraK) (Fee: 0%\*)**: No account needed, one-time donation
- **[Paypal](https://paypal.me/ClaraCrazy) (Fee: 2%\*)**: Account needed, one-time donation
- **Monero (Fee: ~2.5%\*)**: `41kyWeeoVdK4quzQ4M9ikVGs6tCQCLfdx8jLExTNsAu2SF1QAyDqRdjfGM6EL8L9NpXwt89HJeAoGf1aoArk7nDr4AMMV4T`

**Thanks for all your support <3**