generated from kriasoft/react-starter-kit
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 20a19cf
Showing
87 changed files
with
15,635 additions
and
0 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# For more information about the properties used in | ||
# this file, please see the EditorConfig documentation: | ||
# https://editorconfig.org/ | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_size = 2 | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
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 |
---|---|---|
@@ -0,0 +1,87 @@ | ||
/* SPDX-FileCopyrightText: 2014-present Kriasoft */ | ||
/* SPDX-License-Identifier: MIT */ | ||
|
||
/** | ||
* ESLint configuration. | ||
* | ||
* @see https://eslint.org/docs/user-guide/configuring | ||
* @type {import("eslint").Linter.Config} | ||
*/ | ||
module.exports = { | ||
root: true, | ||
|
||
env: { | ||
es6: true, | ||
}, | ||
|
||
extends: [ | ||
"eslint:recommended", | ||
"plugin:import/recommended", | ||
"plugin:import/typescript", | ||
"prettier", | ||
], | ||
|
||
parserOptions: { | ||
ecmaVersion: 2022, | ||
sourceType: "module", | ||
}, | ||
|
||
overrides: [ | ||
{ | ||
files: ["*.ts", "*.tsx"], | ||
parser: "@typescript-eslint/parser", | ||
extends: [ | ||
"plugin:@typescript-eslint/recommended", | ||
"plugin:react/recommended", | ||
"plugin:react-hooks/recommended", | ||
], | ||
rules: { | ||
"react/no-children-prop": "off", | ||
"react/react-in-jsx-scope": "off", | ||
}, | ||
plugins: ["@typescript-eslint"], | ||
parserOptions: { | ||
warnOnUnsupportedTypeScriptVersion: true, | ||
}, | ||
}, | ||
{ | ||
files: ["*.test.js"], | ||
env: { jest: true }, | ||
}, | ||
{ | ||
files: [ | ||
".eslintrc.cjs", | ||
"app/vite.config.ts", | ||
"babel.config.cjs", | ||
"rollup.config.mjs", | ||
"scripts/**/*.js", | ||
], | ||
env: { node: true }, | ||
}, | ||
{ | ||
files: ["*.cjs"], | ||
parserOptions: { sourceType: "script" }, | ||
}, | ||
], | ||
|
||
ignorePatterns: [ | ||
"/.cache", | ||
"/.git", | ||
"/.husky", | ||
"/.yarn", | ||
"/*/dist", | ||
"/app/queries", | ||
], | ||
|
||
settings: { | ||
"import/resolver": { | ||
typescript: { | ||
project: ["app/tsconfig.json", "edge/tsconfig.json"], | ||
}, | ||
}, | ||
"import/core-modules": ["__STATIC_CONTENT_MANIFEST"], | ||
react: { | ||
version: "detect", | ||
}, | ||
}, | ||
}; |
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 |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Automatically normalize line endings for all text-based files | ||
# https://git-scm.com/docs/gitattributes#_end_of_line_conversion | ||
|
||
* text=auto | ||
|
||
# For the following file types, normalize line endings to LF on | ||
# checkin and prevent conversion to CRLF when they are checked out | ||
# (this is required in order to prevent newline related issues like, | ||
# for example, after the build script is run) | ||
|
||
.* text eol=lf | ||
*.css text eol=lf | ||
*.html text eol=lf | ||
*.js text eol=lf | ||
*.json text eol=lf | ||
*.md text eol=lf | ||
*.sh text eol=lf | ||
*.ts text eol=lf | ||
*.txt text eol=lf | ||
*.xml text eol=lf | ||
|
||
/.yarn/** linguist-vendored |
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 |
---|---|---|
@@ -0,0 +1,147 @@ | ||
# Contributing to React Starter Kit | ||
|
||
♥ [React Starter Kit](https://github.com/kriasoft/react-starter-kit) and | ||
want to get involved? Thanks! There are plenty of ways you can help! | ||
|
||
Please take a moment to review this document in order to make the contribution | ||
process easy and effective for everyone involved. | ||
|
||
Following these guidelines helps to communicate that you respect the time of | ||
the developers managing and developing this open source project. In return, | ||
they should reciprocate that respect in addressing your issue or assessing | ||
patches and features. | ||
|
||
## Using the issue tracker | ||
|
||
The [issue tracker](https://github.com/kriasoft/react-starter-kit/issues) is | ||
the preferred channel for [bug reports](#bugs), [features requests](#features) | ||
and [submitting pull requests](#pull-requests), but please respect the following | ||
restrictions: | ||
|
||
- Please **do not** use the issue tracker for personal support requests (use | ||
[Stack Overflow](https://stackoverflow.com/questions/tagged/react-starter-kit), | ||
[Gitter](https://gitter.im/kriasoft/react-starter-kit), | ||
[HackHands](https://hackhands.com/koistya) or | ||
[Codementor](https://www.codementor.io/koistya)). | ||
|
||
- Please **do not** derail or troll issues. Keep the discussion on topic and | ||
respect the opinions of others. | ||
|
||
<a name="bugs"></a> | ||
|
||
## Bug reports | ||
|
||
A bug is a _demonstrable problem_ that is caused by the code in the repository. | ||
Good bug reports are extremely helpful - thank you! | ||
|
||
Guidelines for bug reports: | ||
|
||
1. **Use the GitHub issue search** — check if the issue has already been | ||
reported. | ||
|
||
2. **Check if the issue has been fixed** — try to reproduce it using the | ||
latest `main` or development branch in the repository. | ||
|
||
3. **Isolate the problem** — ideally create fork of this repo with an | ||
example of how to reproduce the problem. | ||
|
||
A good bug report shouldn't leave others needing to chase you up for more | ||
information. Please try to be as detailed as possible in your report. What is | ||
your environment? What steps will reproduce the issue? What would you expect | ||
to be the outcome? All these details will help people to fix any potential bugs. | ||
|
||
Example: | ||
|
||
> Short and descriptive example bug report title | ||
> | ||
> A summary of the issue and the Node.js/OS environment in which it occurs. If | ||
> suitable, include the steps required to reproduce the bug. | ||
> | ||
> 1. This is the first step | ||
> 2. This is the second step | ||
> 3. Further steps, etc. | ||
> | ||
> `<url>` - a link to the reduced test case | ||
> | ||
> Any other information you want to share that is relevant to the issue being | ||
> reported. This might include the lines of code that you have identified as | ||
> causing the bug, and potential solutions (and your opinions on their | ||
> merits). | ||
<a name="features"></a> | ||
|
||
## Feature requests | ||
|
||
Feature requests are welcome. But take a moment to find out whether your idea | ||
fits with the scope and aims of the project. It's up to _you_ to make a strong | ||
case to convince the project's developers of the merits of this feature. Please | ||
provide as much detail and context as possible. | ||
|
||
<a name="pull-requests"></a> | ||
|
||
## Pull requests | ||
|
||
Good pull requests - patches, improvements, new features - are a fantastic | ||
help. They should remain focused in scope and avoid containing unrelated | ||
commits. | ||
|
||
**Please ask first** before embarking on any significant pull request (e.g. | ||
implementing features, refactoring code, porting to a different language), | ||
otherwise you risk spending a lot of time working on something that the | ||
project's developers might not want to merge into the project. | ||
|
||
Please adhere to the coding conventions used throughout a project (indentation, | ||
accurate comments, etc.) and any other requirements (such as test coverage). | ||
|
||
Adhering to the following process is the best way to get your work | ||
included in the project: | ||
|
||
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your | ||
fork, and configure the remotes: | ||
|
||
```bash | ||
# Clone your fork of the repo into the current directory | ||
git clone https://github.com/<your-username>/react-starter-kit.git | ||
# Navigate to the newly cloned directory | ||
cd react-starter-kit | ||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream https://github.com/kriasoft/react-starter-kit.git | ||
``` | ||
|
||
2. If you cloned a while ago, get the latest changes from upstream: | ||
|
||
```bash | ||
git checkout main | ||
git pull upstream main | ||
``` | ||
|
||
3. Create a new topic branch (off the main project development branch) to | ||
contain your feature, change, or fix: | ||
|
||
```bash | ||
git checkout -b <topic-branch-name> | ||
``` | ||
|
||
4. Commit your changes in logical chunks. Please adhere to these [git commit | ||
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | ||
or your code is unlikely be merged into the main project. Use Git's | ||
[interactive rebase](https://help.github.com/articles/about-git-rebase/) | ||
feature to tidy up your commits before making them public. | ||
|
||
5. Locally merge (or rebase) the upstream development branch into your topic branch: | ||
|
||
```bash | ||
git pull [--rebase] upstream main | ||
``` | ||
|
||
6. Push your topic branch up to your fork: | ||
|
||
```bash | ||
git push origin <topic-branch-name> | ||
``` | ||
|
||
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) | ||
with a clear title and description. | ||
|
||
**IMPORTANT**: By submitting a patch, you agree to allow the project | ||
owners to license your work under the terms of the [MIT License](LICENSE.txt). |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
github: kriasoft |
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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# GitHub Actions workflow | ||
# https://help.github.com/actions | ||
|
||
name: PR | ||
|
||
on: [pull_request] | ||
|
||
env: | ||
VERSION: ${{ github.event.pull_request.number }} | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: 18 | ||
cache: "yarn" | ||
|
||
# Install dependencies | ||
- run: yarn install | ||
|
||
# Analyze code for potential problems | ||
- run: yarn prettier --check . | ||
- run: yarn lint | ||
- run: yarn tsc --build | ||
|
||
# Test | ||
# - run: yarn test | ||
|
||
# Compile | ||
- run: yarn build | ||
|
||
# Deploy | ||
# - run: yarn deploy |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# GitHub Actions workflow | ||
# https://help.github.com/actions | ||
|
||
name: "conventionalcommits.org" | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- opened | ||
- edited | ||
- synchronize | ||
|
||
jobs: | ||
main: | ||
name: lint | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: amannn/action-semantic-pull-request@v4 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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 |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Include your project-specific ignores in this file | ||
# Read about how to use .gitignore: https://help.github.com/articles/ignoring-files | ||
|
||
# Compiled output | ||
/*/dist/ | ||
|
||
# Yarn package manager with PnP | ||
# https://yarnpkg.com/getting-started/qa/#which-files-should-be-gitignored | ||
.pnp.* | ||
.yarn/* | ||
!.yarn/patches | ||
!.yarn/plugins | ||
!.yarn/releases | ||
!.yarn/sdks | ||
!.yarn/versions | ||
node_modules | ||
|
||
# Logs | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Cache | ||
/.cache | ||
.eslintcache | ||
|
||
# Testing | ||
/coverage | ||
*.lcov | ||
|
||
# Environment variables | ||
*.override.env | ||
|
||
# Visual Studio Code | ||
# https://github.com/github/gitignore/blob/master/Global/VisualStudioCode.gitignore | ||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
!.vscode/react.code-snippets | ||
|
||
# WebStorm | ||
.idea | ||
|
||
# macOS | ||
# https://github.com/github/gitignore/blob/master/Global/macOS.gitignore | ||
.DS_Store |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
_ |
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 |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/usr/bin/env sh | ||
. "$(dirname -- "$0")/_/husky.sh" | ||
|
||
yarn prettier --check . | ||
yarn lint | ||
yarn tsc --build |
Oops, something went wrong.