awwesome Svelte Themes

Awwesome

Enhanced user interface for Awesome Selfhosted

Awwesome

Enhanced user interface for Awesome Selfhosted.

Visit awweso.me for the live version.

Original data by the awesome-selfhosted community, licensed under CC-BY-SA 3.0.

awwesome_screenshot

Tech Stack

Docker

Awwesome is available on Docker Hub.

docker run -p 3000:3000 -v awwesome_data:/usr/src/app/data mkitzmann/awwesome

Or using docker compose:

services:
  awwesome:
    image: mkitzmann/awwesome:latest
    ports:
      - '3000:3000'
    environment:
      - TOKEN_GITHUB=${TOKEN_GITHUB} # optional, for star history
    volumes:
      - data:/usr/src/app/data

volumes:
  data:

The container runs a Node.js server on port 3000. The data volume persists the SQLite database across restarts.

Development

Clone the repository with submodules:

git clone --recurse-submodules https://github.com/mkitzmann/awwesome.git
cd awwesome

Install dependencies and seed the database:

yarn install
yarn seed

Optionally, fetch GitHub star history (requires a personal access token with no extra permissions):

echo "TOKEN_GITHUB=your_token_here" > .env
yarn backfill-stars

Start the development server:

yarn dev

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

BSD 3-Clause

Top categories

Loading Svelte Themes