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

@akbaraditamasp/njin

v1.1.0

Published

Vite Plugin for Making SSR Web Using Twig Engine

Downloads

14

Readme

Njin

Njin is a Vite plugin for building modern JavaScript frontends with server-side rendering using the Twig template engine.

Get Started

Installation

npm create vite@latest
npm i @akbaraditamasp/njin

Vite Config

import njin from "@akbaraditamasp/njin";

export default {
  plugins: [njin.plugin()],
  build: {
    outDir: "./dist/client",
    copyPublicDir: false,
  },
};

Routing & Development

Routing in Njin is automatically handled based on the path of HTML files located in ./src/pages/**/*.html.

Create a simple HTML file ./src/pages/index.html to get started.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Hello</title>
  </head>
  <body>
    Hello World!
  </body>
</html>

Then, run the Vite dev server.

npm run dev

Production

To run the server in production mode, build your project first with the following command.

npm run build

Next, you need to run the server with Njin CLI, which will start an Express app.

npx njin run ./dist/client

Fetch Data

You can also fetch and pass data to the Twig template engine.

Create an ./src/api.js file.

export default {
  root: async () => {
    return {
      companyName: "Njin",
    };
  },
  "pages\\index": async () =>
    fetch("https://jsonplaceholder.typicode.com/posts/1").then((response) =>
      response.json()
    ),
};

Include it in your Vite Config.

import njin from "@akbaraditamasp/njin";
import api from "./src/api";

export default {
  plugins: [njin.plugin({ api })],
  build: {
    outDir: "./dist/client",
    copyPublicDir: false,
  },
};

You can now access the passed data from Twig using keys root and data.

Build Fetch Data for Production

Before running in production mode, you need to build SSR for the api.js file with the following command.

npx vite build --outDir dist/server --ssr src/api.js

Then, run the following command to start the server with fetch data.

npx njin run ./dist/client -a ./dist/server/api.js