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

@boilpress-router-beta/express

v2.1.2

Published

NextJS like routing for express (beta)

Downloads

5

Readme

Boilpress Router Beta (express)

Overview

This project demonstrates the usage of the @boilpress-router-beta/express library with Express.js to set up routing in a TypeScript-based application you can use it with javascript too just change the code accordingly.

Setup

Installation

First, ensure you have the necessary dependencies installed. If not, you can install them using npm or pnpm:

pnpm add express @boilpress-router-beta/express

File Structure

You can put your routes in any folder you want, but for this example, we'll put them in a src/routes folder.

  • src/routes/ - Contains route handlers for your application.
  • src/routes/index.ts - Handles the root route (/).
  • src/routes/hi/index.ts - Handles the /hi route.
  • src/routes/users/[id].ts - Handles dynamic routing for /users/:id.

Usage

index.ts This is the entry point of your application.

import { boilpressRouter } from "@boilpress-router-beta/express";
import express from "express";

const app = express();
const PORT = 8000;

boilpressRouter(app, {
    path: "src/routes" // Path to your routes folder. If you don't have a 'src' folder, just use 'routes' or whatever your folder is named.
});

app.listen(PORT, () => {
    console.log(`Server is running on port ${PORT}`);
});

Route Handlers

src/routes/index.ts Handles the root route (/).

import { Request, Response } from 'express';

export function GET(req: Request, res: Response): void {
    res.send("Hello from the index route!");
}

src/routes/hi/index.ts Handles the /hi route.

import { Request, Response } from 'express';

export function GET(req: Request, res: Response): void {
    res.send("Hello from the hi route!");
}

src/routes/users/[id].ts Handles dynamic routing for /users/:id.

import { Request, Response, NextFunction } from 'express';

export function GET(req: Request, res: Response, next: NextFunction): void {
    const { id } = req.params;
    res.send(`User ID: ${id}`);
}

Notes

  • You can create nested routes by creating folders inside the routes folder.
  • You can also create a [id].ts file to handle dynamic routing for /users/:id.
  • Remember for now, if you have any file that ends with .ts, .js, .cjs or .mjs, it will be treated as a route please let me know if i should change it with something like route.ts or something else.

This is a utility library for my other project called boilpress (under development).

Contributing

This project is open-source, so like... please help me out. I legit can't handle this shit on my own 😭🙏.

Contact

If you need to ask something or drop some feedback, just hit me up on Discord: @iee3dev or Twitter: @ee3dev. And come join my Discord server before I start talking to myself! (I need friends 😭)