https://github.com/edmundhung/remix-guide

A platform for sharing everything about Remix
https://github.com/edmundhung/remix-guide

cloudflare-workers durable-objects remix-run

Last synced: 9 days ago
JSON representation

A platform for sharing everything about Remix

• Host: GitHub
• URL: https://github.com/edmundhung/remix-guide
• Owner: edmundhung
• License: mit
• Created: 2021-11-17T00:25:36.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-05T20:25:08.000Z (over 1 year ago)
• Last Synced: 2024-10-15T09:11:30.754Z (25 days ago)
• Topics: cloudflare-workers, durable-objects, remix-run
• Language: TypeScript
• Homepage: https://remix.guide
• Size: 1.64 MB
• Stars: 269
• Watchers: 4
• Forks: 32
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-Remix - remix guide - [website](https://remix.guide/discover) (Build with Remix)
• jimsghstars - edmundhung/remix-guide - A platform for sharing everything about Remix (TypeScript)

README

        
# remix-guide

Remix Guide is a platform for sharing everything about Remix. It is built with [Remix](https://remix.run) and is deployed to [Cloudflare Workers](https://workers.cloudflare.com/). All contents are saved in Durable Objects and cached with Worker KV.

## Roadmap

The idea behind Remix Guide is to make resources from the community more accessible and making the process as automatic as possible at the same time. Future plans include:

- Make and share your own list

- Better search ranking / recommendations

- Support searching by language and version (remix and packages)

## Submission

As of v1.0, new resources can only be submitted online. There are some basic validations in place to ensure the submitted URL is relevant to remix. However, in order to minimize the risk of spamming or phishing, additional measures have to be added before it is generally available.

If you would like to submit new content, feel free to share them on the `#showcase` channel of the [Remix Discord](https://discord.com/invite/remix). We are watching the channel and will publish anything shared there as soon as possible.

## Development

To run Remix Guide locally, please make a `.env` file based on `.env.example` first. You can then start the app in development mode using:

```sh

npm run dev

```

This should kickstart a dev server and open the webpage on the browser automatically.

## Node Version

Please make sure the node version is **>= 16.7**. If you are using `nvm`, simply run:

```sh

nvm use

```

This allows [miniflare](https://github.com/cloudflare/miniflare) to serve a development environment as close to the actual worker runtime as possibile.