-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Remove all examples * Update examples readme
- Loading branch information
Showing
1,314 changed files
with
1 addition
and
39,221 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1 @@ | ||
# Remix Examples | ||
|
||
Welcome to the examples for Remix. | ||
|
||
Here you'll find various examples of using Remix to accomplish certain tasks. Each example is a complete application including a build and even a button to preview a live instance of the app so you can play with it. | ||
|
||
Also, remember to check out the README! | ||
|
||
You can also initialize a new project with any of these examples using the `--template` flag of the `create-remix` CLI. For example: | ||
|
||
``` | ||
npx create-remix --template https://github.com/remix-run/remix/tree/main/examples/tailwindcss | ||
``` | ||
|
||
Enjoy! | ||
|
||
## Contributing | ||
|
||
▶️ [Watch Kent show you how to create examples](https://www.youtube.com/watch?v=10AhByQA6Q0). | ||
|
||
Thanks for your willingness to contribute an example to Remix. Examples are incredibly helpful to people like you who are trying to figure out how to use Remix to solve certain problems and integrate with other tools. | ||
|
||
What makes a good example is focus. There's certainly room for examples that show off a whole app experience and we do have some examples like that. But the vast majority of useful examples are focused on a specific use-case. Otherwise it's hard for people to know what to look for in the code. | ||
|
||
This means you should avoid adding stuff that isn't absolutely necessary for the example. Start with bare bones and add only what you need. | ||
|
||
Most examples should: | ||
|
||
- Not use a database | ||
- Have no more than one or two routes (some may not even need any routes) | ||
- Have only necessary deps | ||
- Not use complex validation | ||
- Use TypeScript | ||
- Be as practical as reasonable (balanced with the focus). Just, no `foo`/`bar` please. | ||
|
||
To create an example, simply copy/paste the [`template`](template) directory into a new one with a sensible name, make the changes you need for your example, update the `README.md` and open a PR! | ||
|
||
Thanks! | ||
Remix examples have moved into a dedicated repository. [See `remix-run/examples`](https://github.com/remix-run/examples) to browse or contribute new example projects! |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.