https://github.com/oresoftware/humpty-dumpty
https://github.com/oresoftware/humpty-dumpty
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/oresoftware/humpty-dumpty
- Owner: ORESoftware
- License: mit
- Created: 2016-12-24T18:30:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-30T04:28:02.000Z (almost 8 years ago)
- Last Synced: 2023-03-02T00:26:03.222Z (about 3 years ago)
- Language: Shell
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Your Project Readme Goes Here
Steps to making this project skeleton into your own project.
1. Clone this repo:
`git clone https://github.com/your-org/humpty-dumpty.git YOUR-PROJECT-NAME`
2. Update package.json so that `name` property matches `YOUR-PROJECT-NAME`.
3. Update other package.json fields so that they are accurate.
To check to see if `YOUR-PROJECT-NAME` is available on NPM, uses this command at the command line:
`$ npm view YOUR-PROJECT-NAME` # will give you a 404 if the name is available.
### This project skeleton uses:
* the correct semver initial value (npm init defaults to 1.0.0 which is just wrong).
* typescript 2.x
* nodejs version 9
* travis (for automated testing of your library)
* MIT license
* good simple default settings for .gitignore / .npmignore
To compile your *.ts files to a dist directory (keeps your source and target files separate),
simply add this to tsconfig.json:
```json
"compilerOptions": {
"outDir": "dist"
}
```
and
```json
"include": [
"src"
]
```
For small libraries with a couple of files, I find that using a dist folder (target directory) is more trouble
than it's worth. For projects with just one .ts/.js file, you can just get rid of the lib folder, and put your index.ts
file in the root of the project. In that case, make sure to change the `main` property in package.json from 'lib/index.js' to
'index.js'. Same with the `typings/types` properties.