Remix Guide

Overview

Remix Guide is a platform built with Remix and deployed to Cloudflare Workers. It serves as a hub for sharing resources and information about Remix. All contents are stored using Durable Objects and cached with Worker KV.

Features

• Community resource sharing: Remix Guide makes community resources more accessible by providing a platform to share them.
• Automated process: The platform aims to make the sharing process as automatic as possible.
• Make and share your own list: Future plans for Remix Guide include the ability to create and share personalized resource lists.
• Better search ranking / recommendations: The platform plans to improve search ranking and provide better resource recommendations.
• Search by language and version: Users will be able to search for resources based on language and Remix version.
• Submission process: New resources can currently be submitted online through validations. However, additional measures will be added to prevent spamming or phishing.
• Submission through Remix Discord: Users can share new resources on the #showcase channel of the Remix Discord for publication.

Installation

To run Remix Guide locally, follow these steps:

1. Create a .env file based on the provided .env.example.
2. Start the app in development mode by using the following command:

npm start

This will launch a dev server and automatically open the webpage in your browser.

Please ensure that your Node version is equal to or greater than 16.7. If you are using nvm, you can update it by running:

nvm install 16.7

This will ensure that the development environment closely mimics the worker runtime.

Summary

Remix Guide is a platform built with Remix and deployed to Cloudflare Workers. It aims to make resources about Remix more accessible to the community. The platform allows users to share resources, create personalized lists, and offers features such as improved search ranking and search by language and version. The process of submitting new resources is currently done online, but additional measures will be implemented to prevent spamming or phishing. To run Remix Guide locally, users need to set up an environment file and start the app in development mode.