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

scratch-up

v1.0.2

Published

Creates code structure with frontend, backend, proxy, database & cache layer. With maintaining focus on ease of development on local & deployment as a container system. Has abstract functions and services for basic functionalities. Written in Typescript.

Downloads

8

Vulnerabilities

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

Links

Git

Maintainers

tauksuntauksun

Keywords

frameworkinfrastructureboilerplate

Readme

Scratch-Up

USE : npx scratch-up myApp

A framework to generate structure with frontend, backend, proxy, database & cache layer. With maintaining focus on ease of development on local & deployment as a container system.

Initialises code & structure with basic functionalities, enabling you to focus on application logic.

Get Started with : npx scratch-up myApp

Setup & Customize as per your needs.

Configuration

  • database : Postgres
  • cache layer : Redis
  • proxy : Nginx
  • frontend : React based, Express hosted (Typescript)
  • backend : Express based server (Typescript)
  • Test Framework : Jest
  • containerization : Docker

Pre-Requisite

  • Nodejs
  • Docker & Docker-Compose
  • Good Internet : First-time running docker-compose up fetches image for Postgres, Nginx, Nodejs & Redis.

Getting Started

(on linux : use sudo as required)

  • Setup with : npx scratch-up myApp
  • Start Application : docker-compose up

For Local Development

  • Start proxy, database & cache with: docker-compose -f start--proxy-and-databases.yml up
  • Start backend :
    • Change directory to backend
    • Run : npm install
    • Run: npm run start:dev
  • Start frontend :
    • Change directory to frontend
    • Run: npm install
    • Run: npm run start:dev

Code base is documented with function definitions & examples.

View Application at : http://localhost

Upcoming

  • Tests
  • Proper Documentation with website
  • Admin Panel

Contact

Write at : [email protected]