Skip to content

Commit 736d60d

Browse files
committed
Add a few things before publishing first version
1 parent 6b6f5bd commit 736d60d

File tree

3 files changed

+48
-3
lines changed

3 files changed

+48
-3
lines changed

LICENCE

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) 2020 digital-wafa
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: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,13 @@ This repository acts as a template to bootstrap a new React project using Vite a
2121

2222
## Getting Started
2323

24+
Before creating a project you just install NodeJS. It is recommended to use the latest LTS version.
25+
2426
```
25-
npx degit ztolley/vite-ts#main my-project
27+
npx degit ztolley/vite-react-ts#main my-project
28+
cd my-project
29+
npm install
30+
npm run dev
2631
```
2732

2833
## Folder Structure

package.json

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
{
2-
"name": "ztolley-vite-react-ts",
3-
"private": false,
2+
"name": "@ztolley/vite-react-ts",
43
"version": "0.1.0",
4+
"description": "A starter template for Vite + React + TypeScript",
5+
"private": false,
56
"type": "module",
7+
"keywords": [
8+
"vite",
9+
"react",
10+
"typescript",
11+
"starter",
12+
"vitest",
13+
"cypress"
14+
],
15+
"author": "Zac Tolley <zac@thetolleys.com>",
16+
"license": "MIT",
17+
"repository": {
18+
"type": "git",
19+
"url": "https://github.com/ztolley/vite-react-ts.git"
20+
},
21+
"bugs": {
22+
"url": "https://github.com/ztolley/vite-react-ts/issues"
23+
},
24+
"homepage": "https://github.com/ztolley/vite-react-ts#readme",
625
"scripts": {
726
"build": "tsc && vite build",
827
"coverage": "vitest run --coverage",

0 commit comments

Comments
 (0)