npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typescript-project-generator

v6.0.0

Published

A TypeScript initial configuration for web projects

Downloads

54

Readme

NPM version GitHub license JavaScript Style Guide PRs Welcome Lint

This project has the goal to create a basic setup for a TypeScript project. It will create many files that are usually created manually. Currently the following files are being created:

  • .env
  • .eslintignore
  • .eslintrc
  • .gitignore
  • CHANGELOG.md
  • Dockerfile
  • heroku.yml (optional)
  • jest.config.ts (optional)
  • LICENSE (MIT as example)
  • nodemon.json
  • package.json
  • README.md
  • tsconfig.base.json
  • tsconfig.json

The following questions will be asked to the user:

  • Select your package manager:, npm, yarn and pnpm area available.
  • Project name:, at least one character must be provided.
  • Project description:, at least one character must be provided.
  • Author:, at least one character must be provided.
  • Email:, a correct email address must be provided.
  • Project version: the initial version of the project, 0.1.0 as default.
  • Select your license:, MIT, Unlicensed, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0, AGPL 3.0 are available.
  • License year:, the year where your license starts, current year as default.
  • Would you want to have a basic GitHub Action for the suit of tests and linting? [y/n].

What is new?

Please check the changelog.md file.

Project structure

📂.github
 ┣ 📂workflows
   ┣ 📜lint.yml
   ┗ 📜test.yml
📂src
 ┗ 📜index.ts
📂test
 ┗ 📜index.test.ts
📜.env
📜.eslintignore
📜.eslintrc
📜.gitignore
📜CHANGELOG.md
📜Dockerfile
📜heroku.yml
📜LICENSE
📜package.json
📜README.md
📜tsconfig.base.json
📜tsconfig.json
📜yarn.lock (or package-lock.json or pnpm-lock.yaml)

Finally, git will be initialized and a list of libraries will be installed. Check the notes.

Prerequisites

You need to have internet connection to install the packages and to get the license from this web page.

Installation

This project was intended to be installed globally, not locally, and also to initialize projects, be aware of that, you may broke something in your current working directory.

In order to install this package, run the following command in your terminal:

npm i -g typescript-project-generator

Usage

Once you have installed the package, please run the following command in your terminal:

tpg

This will guide you in a process to initialize your new project, asking you the questions shown above.

Notes

Here is the list of the packages that are being installed, as devDependencies:

Feel free to contribute to this project. Every contribution will be appreciated.

Hey, this project use to contain a backend generator!

Yes, it used to. But that approach has been deprecated in favor of my new backend framework, Simba.js.

Author

  • Anthony Luzquiños - Initial Work - Documentation - AnthonyLzq.

Contributors