Awwesome

Overview:

Awwesome is an enhanced user interface for the Awesome Selfhosted project, utilizing data from the Awesome-Selfhosted community under CC-BY-SA 3.0. The technology stack includes Svelte and Tailwind, with additional data fetched from GitHub’s GraphQL API. Users need a personal access token from GitHub to use the API effectively and are recommended to employ a fine-grained token for security reasons.

Features:

• Enhanced User Interface: Awwesome offers an enhanced user interface for navigating the Awesome Selfhosted project.
• Data Enrichment: Fetches additional data from GitHub’s GraphQL API to supplement the project listings.
• Svelte and Tailwind Integration: Built using the Svelte framework and utilizes Tailwind for styling.
• Docker Deployment: Awwesome can be easily deployed using Docker and docker compose.

Installation:

To install Awwesome theme, follow these steps:

1. Clone the repository:

   git clone [repository-url]
   

2. Install dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

4. Add your personal GitHub access token to a .env file in the root directory.

For production, it is advisable to statically generate Awwesome instead of server-rendering to enhance user experience. Use the provided docker-compose.yml file to deploy using Docker, mapping the site to an nginx server on port 8080.

Summary:

Awwesome is a project that enhances the user interface for the Awesome Selfhosted community, leveraging data from GitHub’s GraphQL API. Utilizing Svelte and Tailwind, the theme recommends the use of fine-grained personal access tokens for security. Deployment is made easy through Docker, with suggestions for optimizing performance by statically generating the site and setting it up with Docker and nginx.