Skip to content

Commit

Permalink
Add a few things before publishing first version
Browse files Browse the repository at this point in the history
  • Loading branch information
ztolley committed May 24, 2023
1 parent 6b6f5bd commit 736d60d
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 digital-wafa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,13 @@ This repository acts as a template to bootstrap a new React project using Vite a

## Getting Started

Before creating a project you just install NodeJS. It is recommended to use the latest LTS version.

```
npx degit ztolley/vite-ts#main my-project
npx degit ztolley/vite-react-ts#main my-project
cd my-project
npm install
npm run dev
```

## Folder Structure
Expand Down
23 changes: 21 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
{
"name": "ztolley-vite-react-ts",
"private": false,
"name": "@ztolley/vite-react-ts",
"version": "0.1.0",
"description": "A starter template for Vite + React + TypeScript",
"private": false,
"type": "module",
"keywords": [
"vite",
"react",
"typescript",
"starter",
"vitest",
"cypress"
],
"author": "Zac Tolley <[email protected]>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/ztolley/vite-react-ts.git"
},
"bugs": {
"url": "https://github.com/ztolley/vite-react-ts/issues"
},
"homepage": "https://github.com/ztolley/vite-react-ts#readme",
"scripts": {
"build": "tsc && vite build",
"coverage": "vitest run --coverage",
Expand Down

0 comments on commit 736d60d

Please sign in to comment.