Skip to content

Commit 3873e91

Browse files
committed
Initial commit from create-remix
0 parents  commit 3873e91

27 files changed

+11837
-0
lines changed

.eslintrc.cjs

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
/**
2+
* This is intended to be a basic starting point for linting in your app.
3+
* It relies on recommended configs out of the box for simplicity, but you can
4+
* and should modify this configuration to best suit your team's needs.
5+
*/
6+
7+
/** @type {import('eslint').Linter.Config} */
8+
module.exports = {
9+
root: true,
10+
parserOptions: {
11+
ecmaVersion: "latest",
12+
sourceType: "module",
13+
ecmaFeatures: {
14+
jsx: true,
15+
},
16+
},
17+
env: {
18+
browser: true,
19+
commonjs: true,
20+
es6: true,
21+
},
22+
23+
// Base config
24+
extends: ["eslint:recommended"],
25+
26+
overrides: [
27+
// React
28+
{
29+
files: ["**/*.{js,jsx,ts,tsx}"],
30+
plugins: ["react", "jsx-a11y"],
31+
extends: [
32+
"plugin:react/recommended",
33+
"plugin:react/jsx-runtime",
34+
"plugin:react-hooks/recommended",
35+
"plugin:jsx-a11y/recommended",
36+
],
37+
settings: {
38+
react: {
39+
version: "detect",
40+
},
41+
formComponents: ["Form"],
42+
linkComponents: [
43+
{ name: "Link", linkAttribute: "to" },
44+
{ name: "NavLink", linkAttribute: "to" },
45+
],
46+
"import/resolver": {
47+
typescript: {},
48+
},
49+
},
50+
},
51+
52+
// Typescript
53+
{
54+
files: ["**/*.{ts,tsx}"],
55+
plugins: ["@typescript-eslint", "import"],
56+
parser: "@typescript-eslint/parser",
57+
settings: {
58+
"import/internal-regex": "^~/",
59+
"import/resolver": {
60+
node: {
61+
extensions: [".ts", ".tsx"],
62+
},
63+
typescript: {
64+
alwaysTryTypes: true,
65+
},
66+
},
67+
},
68+
extends: [
69+
"plugin:@typescript-eslint/recommended",
70+
"plugin:import/recommended",
71+
"plugin:import/typescript",
72+
],
73+
},
74+
75+
// Node
76+
{
77+
files: [".eslintrc.js"],
78+
env: {
79+
node: true,
80+
},
81+
},
82+
],
83+
};

.github/.kodiak.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version = 1
2+
3+
[merge.automerge_dependencies]
4+
versions = ["minor", "patch"]
5+
usernames = ["renovate"]
6+
7+
[approve]
8+
auto_approve_usernames = ["renovate"]

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @netlify/ecosystem-pod-frameworks

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
3+
## Related Tickets & Documents
4+
5+
<!--
6+
For pull requests that relate or close an issue, please include them
7+
below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
8+
9+
For example having the text: "closes #1234" would connect the current pull
10+
request to issue 1234. And when we merge the pull request, Github will
11+
automatically close the issue.
12+
-->
13+
14+
- Related Issue #
15+
- Closes #
16+
17+
## QA Instructions, Screenshots, Recordings
18+
19+
_Please replace this line with instructions on how to test your changes_
20+
21+
For us to review and ship your PR efficiently, please perform the following steps:
22+
23+
- [ ] Open a [bug/issue](https://github.com/netlify/remix-edge-template/issues/new/choose) before writing your code 🧑‍💻. This ensures we
24+
can discuss the changes and get feedback from everyone that should be involved. If you\`re fixing a typo or
25+
something that\`s on fire 🔥 (e.g. incident related), you can skip this step.
26+
- [ ] Read the [contribution guidelines](../blob/main/CONTRIBUTING.md) 📖. This ensures your code follows our style
27+
guide and passes our tests.
28+
- [ ] Update or add tests (if any source code was changed or added) 🧪
29+
- [ ] Update or add documentation (if features were changed or added) 📝
30+
- [ ] Make sure the status checks below are successful ✅
31+
32+
**A picture of a cute animal (not mandatory, but encouraged)**

.github/workflows/labeller.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Label PR
2+
on:
3+
pull_request:
4+
types: [opened, edited]
5+
6+
jobs:
7+
label-pr:
8+
if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false
9+
runs-on: ubuntu-latest
10+
strategy:
11+
matrix:
12+
pr:
13+
[
14+
{ prefix: 'fix', type: 'bug' },
15+
{ prefix: 'chore', type: 'chore' },
16+
{ prefix: 'test', type: 'chore' },
17+
{ prefix: 'ci', type: 'chore' },
18+
{ prefix: 'feat', type: 'feature' },
19+
{ prefix: 'security', type: 'security' },
20+
]
21+
steps:
22+
- uses: netlify/[email protected]
23+
if: startsWith(github.event.pull_request.title, matrix.pr.prefix)
24+
with:
25+
token: '${{ secrets.GITHUB_TOKEN }}'
26+
label: 'type: ${{ matrix.pr.type }}'

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
node_modules
2+
3+
/.cache
4+
/public/build
5+
/build
6+
.env
7+
8+
# Local Netlify folder
9+
.netlify
10+
.DS_Store

.prettierrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Netlify Remix Template
2+
3+
Welcome to the Netlify Remix Template project. If you were expecting this to be your site, run `remix init` in the root of this project to get started.
4+
5+
To use the template, run
6+
7+
```bash
8+
npx create-remix@latest --template netlify/remix-template
9+
```
10+
11+
This project includes:
12+
13+
- Netlify Functions template for Remix sites
14+
- Netlify Edge Functions template for Remix sites
15+
16+
From the `create-remix` command, you may pass `--netlify-edge` or `--no-netlify-edge` to generate a template that uses Netlify Edge or Serverless functions explicitly. Without passing this option, the create workflow will ask you which you would prefer.
17+
18+
## Development
19+
20+
There is no need to run `npm install` as this is a template. The Remix CLI will install the dependencies for you. Make changes to files as you see fit. If there are transformations for files for either the Netlify Functions or Netlify Edge Functions template, make the appropriate changes to the `remix.init/index.js` file.
21+
22+
If you're new to Remix stacks and the remix.init concept, see the official [Remix Stacks](https://remix.run/stacks) documentation.
23+
24+
### Testing your changes
25+
26+
Run
27+
28+
```bash
29+
npx create-remix@latest --template ./remix-template
30+
```
31+
32+
to test your changes to the template. Follow the steps the Remix CLI prompts you with to create a new project. Ensure to test for both the Netlify Functions template and the Netlify Edge Functions template.

0 commit comments

Comments
 (0)