-
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
Showing
2 changed files
with
15 additions
and
7 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 |
---|---|---|
|
@@ -19,17 +19,25 @@ It is primarily for me, but if you find it useful, that's great! | |
|
||
```sh | ||
# Clone the template locally | ||
git clone [email protected]:sebkolind/ts-lib-starter.git ./my-project | ||
git clone [email protected]:sebkolind/ts-lib-starter.git my-project | ||
|
||
# Install dependencies | ||
# Change working directory to your project | ||
cd my-project | ||
npm add | ||
``` | ||
|
||
Now, you can use any of the `npm` commands: | ||
### Configure package | ||
|
||
Open the `package.json` file and change the `name`, `description` and `author` fields to something you'd like. | ||
The `name` should be unique and you should use a namespace (like how I use `@sebkolind` for my packages), | ||
`author` is you and `description` is a short summary of what your package is about. | ||
|
||
### Start building | ||
|
||
```sh | ||
# Devlopement | ||
# Install dependencies | ||
npm install | ||
|
||
# Development | ||
npm run dev | ||
|
||
# Run tests | ||
|
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 |
---|---|---|
@@ -1,7 +1,8 @@ | ||
{ | ||
"name": "@sebkolind/ts-lib-starter", | ||
"version": "0.0.1", | ||
"name": "@sebkolind/ts-lib-starter", | ||
"description": "A TypeScript library starter template", | ||
"author": "sebkolind <[email protected]>", | ||
"source": "lib/main.ts", | ||
"module": "dist/main.js", | ||
"type": "module", | ||
|
@@ -20,7 +21,6 @@ | |
"library", | ||
"parcel" | ||
], | ||
"author": "sebkolind <[email protected]>", | ||
"license": "MIT", | ||
"devDependencies": { | ||
"@parcel/packager-ts": "^2.12.0", | ||
|