Skip to content

Commit cdae714

Browse files
jherrjherr
committed
Adding more project configuration
1 parent 7a7d8d6 commit cdae714

File tree

7 files changed

+168
-6
lines changed

7 files changed

+168
-6
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

‎.github/FUNDING.yml‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: '🐛 Bug report'
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for reporting an issue :pray:.
8+
9+
This issue tracker is for reporting bugs found in `create-tanstack-app` (https://github.com/tanstack/create-tanstack-app).
10+
If you have a question about how to achieve something and are struggling, please post a question
11+
inside of `create-tanstack-app` Discussions tab: https://github.com/tanstack/create-tanstack-app/discussions
12+
13+
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
14+
- `create-tanstack-app` Issues tab: https://github.com/tanstack/create-tanstack-app/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
15+
- `create-tanstack-app` closed issues tab: https://github.com/tanstack/create-tanstack-app/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
16+
- `create-tanstack-app` Discussions tab: https://github.com/tanstack/create-tanstack-app/discussions
17+
18+
The more information you fill in, the better the community can help you.
19+
- type: dropdown
20+
id: project
21+
attributes:
22+
label: Which project does this relate to?
23+
description: If you are unsure, please leave this as "Create Tanstack App".
24+
options:
25+
- Create Tanstack App
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: description
30+
attributes:
31+
label: Describe the bug
32+
description: Provide a clear and concise description of the challenge you are running into.
33+
validations:
34+
required: true
35+
- type: input
36+
id: link
37+
attributes:
38+
label: Your Example Website or App
39+
description: |
40+
Which website or app were you using when the bug happened?
41+
Note:
42+
- Please provide a link via our pre-configured Stackblitz project ([file-based routes](https://stackblitz.com/github/tanstack/router/tree/main/examples/react/quickstart-file-based?file=src%2Fmain.tsx)|[code-based routes](https://stackblitz.com/github/tanstack/router/tree/main/examples/react/quickstart?file=src%2Fmain.tsx)) or a link to a repo that can reproduce the issue.
43+
- Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `router` npm package / dependency.
44+
- To create a shareable code example you can use Stackblitz. Please no localhost URLs.
45+
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
46+
placeholder: reproduction URL
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: steps
51+
attributes:
52+
label: Steps to Reproduce the Bug or Issue
53+
description: Describe the steps we have to take to reproduce the behavior.
54+
placeholder: |
55+
1. Go to '...'
56+
2. Click on '....'
57+
3. Scroll down to '....'
58+
4. See error
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: expected
63+
attributes:
64+
label: Expected behavior
65+
description: Provide a clear and concise description of what you expected to happen.
66+
placeholder: |
67+
As a user, I expected ___ behavior but i am seeing ___
68+
validations:
69+
required: true
70+
- type: textarea
71+
id: screenshots_or_videos
72+
attributes:
73+
label: Screenshots or Videos
74+
description: |
75+
If applicable, add screenshots or a video to help explain your problem.
76+
For more information on the supported file image/file types and the file size limits, please refer
77+
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
78+
placeholder: |
79+
You can drag your video or image files inside of this editor ↓
80+
- type: textarea
81+
id: platform
82+
attributes:
83+
label: Platform
84+
value: |
85+
- OS: [e.g. macOS, Windows, Linux]
86+
- Browser: [e.g. Chrome, Safari, Firefox]
87+
- Version: [e.g. 91.1]
88+
validations:
89+
required: true
90+
- type: textarea
91+
id: additional
92+
attributes:
93+
label: Additional context
94+
description: Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Feature Requests & Questions
4+
url: https://github.com/tanstack/router/discussions
5+
about: Please ask and answer questions here.
6+
- name: 💬 Community Chat
7+
url: https://discord.gg/mQd7egN
8+
about: A dedicated discord server hosted by Tanner Linsley
9+
- name: 💬 Tanstack Twitter
10+
url: https://twitter.com/tan_stack
11+
about: Stay up to date with new releases of our libraries

‎CONTRIBUTING.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
- Clone the repo
4+
- `gh repo clone TanStack/create-tanstack-app`
5+
- Ensure `node` is installed
6+
- https://nodejs.org/en/
7+
- Ensure `pnpm` is installed
8+
- https://pnpm.io/installation
9+
- Why? We use `pnpm` to manage workspace dependencies. It's easily the best monorepo/workspace experience available as of when this was written.
10+
- Install dependencies
11+
- `pnpm install`
12+
- This installs dependencies for all of the packages in the monorepo, even examples!
13+
- Dependencies inside of the packages and examples are automatically linked together as local/dynamic dependencies.
14+
- Run the build
15+
- `pnpm build`
16+
- Build an example app with the builder
17+
- `pnpm start app-js`
18+
- Run the `app-js` app just to make sure it works
19+
- Make changes to the code
20+
- Re-run `pnpm build` and `pnpm start` (in all its configurations) to make sure the changes work
21+
- Check your work and PR
22+
23+
# Testing combinations
24+
25+
These must all product running applications that can be built (`pnpm build`) and tested (`pnpm test`).
26+
27+
| Command | Description |
28+
| ------------------------------------------------------- | ------------------------------------------ |
29+
| `pnpm start app-js` | Creates a JavaScript app |
30+
| `pnpm start app-ts --template typescript` | Creates a TypeScript app |
31+
| `pnpm start app-js-tw --tailwind` | Creates a JavaScript app with Tailwind CSS |
32+
| `pnpm start app-ts-tw --template typescript --tailwind` | Creates a TypeScript app with Tailwind CSS |

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021-present Tanner Linsley
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,16 @@ This CLI applications builds Tanstack Start applications that are the functional
66

77
```bash
88
pnpm i
9+
pnpm build
910
```
1011

1112
# Manual testing
1213

13-
| Command | Description |
14-
| -------------------------------------------------- | ------------------------------------------ |
15-
| `npx . app-js` | Creates a JavaScript app |
16-
| `npx . app-ts --template typescript` | Creates a TypeScript app |
17-
| `npx . app-js-tw --tailwind` | Creates a JavaScript app with Tailwind CSS |
18-
| `npx . app-ts-tw --template typescript --tailwind` | Creates a TypeScript app with Tailwind CSS |
14+
| Command | Description |
15+
| ------------------------------------------------------- | ------------------------------------------ |
16+
| `pnpm start app-js` | Creates a JavaScript app |
17+
| `pnpm start app-ts --template typescript` | Creates a TypeScript app |
18+
| `pnpm start app-js-tw --tailwind` | Creates a JavaScript app with Tailwind CSS |
19+
| `pnpm start app-ts-tw --template typescript --tailwind` | Creates a TypeScript app with Tailwind CSS |
1920

2021
There is also `--package-manager pnpm` that will use [pnpm](https://pnpm.io/) as the package manager (this supports `yarn`, `bun`, and `npm` as well).

0 commit comments

Comments
 (0)