https://github.com/ramantehlan/ts-packaging-101
A repository to help you understand NPM packaging with TypeScript.
https://github.com/ramantehlan/ts-packaging-101
Last synced: 8 days ago
JSON representation
A repository to help you understand NPM packaging with TypeScript.
- Host: GitHub
- URL: https://github.com/ramantehlan/ts-packaging-101
- Owner: ramantehlan
- License: mit
- Created: 2018-09-22T13:02:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-13T13:25:27.000Z (about 5 years ago)
- Last Synced: 2025-03-02T01:30:26.073Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-packaging-101
This repository is to help you get starting with creating your package with Typescript and publish to Github and NPM registry. It contains an example of a module, which helps find the distance of a point from the origin.
This repository is an example of the blog post [Modern Javascript Packaing](https://ramantehlan.github.io/blog/post/2020/modern-javascript-packaging/).
## Prerequisite
Following are some requirements to get started with NPM Packaging:
- Programming experience.
- Exposure to the terminal and basic commands.
## Development Environment
### Install Nodejs and NPM
For Debian-Based Distribution.
```console
$ curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
$ sudo apt-get install -y nodejs
```
You can install Nodejs and NPM for other GNU/Linux distributions from the [Nodejs Download page](https://nodejs.org/en/download/package-manager/).
### Install Git
For Debian-Based Distribution.
```console
$ sudo apt install git-all
```
You can install git for other GNU/Linux distributions from the [Git Download page](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
---
You can also use `Environment.sh` to setup this, but it only supports the following dependency-resolution tools:
- apt
- emerge
- pacman
- yum/rpm
- zypp
```console
$ chmod +x ./Environment.sh
$ ./Environment.sh
```
## Resources
- [NPM Packaging Docs](https://docs.npmjs.com/packages-and-modules/)
- [Github Packaging Docs](https://help.github.com/en/packages)
## License
MIT License