Skip to content

area44/SYWYKE

Repository files navigation

SYWYKE - An Open-Source Site to Find Awesome Websites on the Internet

Built with Astro

SYWYKE banner

SYWYKE is an open-source project that aims to gather and showcase awesome websites on the internet. It provides a platform for users to discover and explore websites based on their interests and preferences.

Features

  • Astro 6: SYWYKE is built using Astro 6, a modern front-end framework for building websites. Astro combines the best of static site generation and server-side rendering to deliver fast, performant websites.

  • React 19 & Tailwind CSS 4: Modern UI components built with React 19 and styled with the latest Tailwind CSS 4.

  • Minimalist Dashboard: A streamlined, interactive dashboard experience for managing and discovering bookmarks.

  • Zustand 5: Global state management for bookmarks, collections, and tags.

  • Pagefind Search: Fast, client-side search functionality powered by Pagefind.

  • Tagging System: Each website in SYWYKE is associated with one or more tags, allowing users to filter websites based on their interests.

  • Easy Contribution: Adding a new website to SYWYKE is simple. Just create a Markdown (.md) file in the src/content/sites/ directory and provide the necessary details like title, site URL, description, and tags.

  • Responsive Design: SYWYKE is designed to be responsive, ensuring that it looks great and functions well on different devices on screen sizes.

Getting Started

To run SYWYKE locally, follow these steps:

  1. Clone the repository: git clone https://github.com/AREA44/SYWYKE.git
  2. Navigate to the project directory: cd SYWYKE
  3. Install dependencies: pnpm install
  4. Start the local development server: pnpm run dev
  5. Open your browser and visit http://localhost:4321 to view the SYWYKE site.

Contributing

If you would like to contribute to SYWYKE, feel free to follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make the necessary changes and commit your changes.
  4. Push the branch to your forked repository.
  5. Open a pull request on the main SYWYKE repository.

License

SYWYKE is licensed under the MIT License.

Credits

We build upon the knowledge and success of these pioneers. Here are a few Open Source projects that have inspired us along the way.