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

@webnsurf/bootstrap

v0.1.7

Published

CLI to bootstrap React projects (including backend) using TypeScript

Downloads

27

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

laurynasgrlaurynasgrwebnsurfwebnsurf

Keywords

project-bootstrapbootstrapreacttypescriptbackendcli

Readme

CLI to bootstrap React projects with TypeScript

A CLI to bootstrap React Applications ranging in complexity from the very simple to more complex setups with CI.

To install run

npm i -g @webnsurf/bootstrap

This will install the package globally and make wns-new command available anywhere on your machine. You can also install it locally and then use it with NPX

To create a new project run

wns-new <project_name> [arguments]

If no project_name is provided the current working directory is used. Each project can be configured with:

The CLI is interactive so specifying the below arguments when running the command is not required.

Arguments:

| Name | Alias | Action | Default value | Info | | ---- | :---: | ------ | :-----------: | ---- | | --yes | -y | Skip the propmpt and use default options | false | Preferred default options to use here can be set and saved using the --set-defaults flag (see below) | --docker | -d | Create a Docker setup within the project | false | This will create the following structure: Docker image build script /docker/build.shDocker container start script /docker/start.shfront-end and back-end Dockerfile.prod & Dockerfile.dev in their corresponding foldersdocker-compose.prod.yml & docker-compose.yml files to easily spin up production and development containersThe default Docker setup uses Web'n'surF Docker network. It allows you to access the development server on https://dev.webnsurf.com and the local "staging" server on https://local.webnsurf.com (both resolve to 127.0.0.1 and are then proxied to the right containers using Web'n'surF proxy). Get the Web'n'surF proxy based on Træfik | --pipeline | -p | Create a Jenkins pipeline | false | This will create the following structure: Jenkinsfile in the root directoryDeployment script /docker/deploy.shRemote start script /docker/start-remote.shThis option automatically sets --docker to true.Specify --server-user & --server-ip options to replace variables in the files listed above.Get the Web'n'surF CI server based on Jenkins | --install | -i | Install node modules | false | Install node modules once the project is initialised | --set-defaults | -s | Set default options | false | Set default options to use next time --yes(-y) is used | --no-backend | N/A | Create a project without a back-end server | false | By default the project is created with an Express JS backend server. This option disables that. | --no-git | N/A | Create a project without Git | false | By default a new Git project is initiated. This option disables that. | --no-router | N/A | Create a project without React router | false | By default React router is included and a few front-end routes are set up. This option disables that.This option can not be disabled if the project is created with Login functionality. | --no-login | N/A | Create a project without login fuctionality | false | By default the project is setup with a redux store and a user login functionality (both back-end and front-end logic). This option disables that | --design | N/A | Specify a design library | null | Sets up, istalls and uses a React design library in the project.Available options:antd (Documentation)Material UI (Documentation) - this option is currently disabled (WIP) | --domain | N/A | Domain name for proxy | webnsurf.com | Specify a domain name to use in the Web'n'surF proxy router setup.This option is only needed if --docker is set to true | --server-user | N/A | Remote server username | <SERVER_USERNAME> | Specify a username on the remote server for the deployment (/docker/deploy.sh) and start-remote (/docker/start-remote.sh) scripts to use.This option is only needed if --pipeline is set to true | --server-ip | N/A | Remote server IP address | <SERVER_IP> | Specify the remote server IP address for the deployment (/docker/deploy.sh) and start-remote (/docker/start-remote.sh) scripts to use.This option is only needed if --pipeline is set to true