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

@n0n3br/starwars-api-capture-serve

v0.0.3

Published

A library to capture all data from Star Wars API (https://swapi.dev/) and serve it locally.

Downloads

2

Readme

StarWars API Capture and Local Serve

Description

A library to capture all data from Star Wars API (https://swapi.dev/) and serve it locally.


Content


About

I made this library to use the Star Wars API in my learning projects without having to deal with the official api rate limit.

All the data is captured and stored in a JSON file and then served with the JSON Server library.

The official url's from the official api are replaced with the localhost:port syntax to make all the navigation between links local.

The standard folder where the resulting json is stored is db, the default filename is swapi.json and the default serve port is 3000.


Requirements

To use this library you must have NodeJS installed in your machine.


Instalation

To install the library use npm:

npm install @n0n3br/starwars-api-capture-serve

How to use

Create a folder to host your project

mkdir my-project

Run the npm init command

cd my-project
npm init -y

Install the library

npm i @n0n3br/starwars-api-capture-serve

create a index.mjs file and write your script

import fs from "fs";
import path from "path";

import { capture, serve } from "@n0n3br/starwars-api-capture-serve";

const dbFolder = "db";
const dbFile = "swapi.json";
const port = 3000;

// optional - check if the database file already exists
// you can always capture a new database before serving, but you may have trouble wth the rate limit
const dbPath = path.resolve(".", dbFolder, dbFile);
if (!fs.existsSync(dbPath)) {
  // Capture function parameters are optional. If not informed, 'db' and 'swapi.json' values will be used
  await capture(dbFolder, dbFile);
}
// serve the resulting data
// Serve function parameters are optional. If not informed 'db', 'swapi.json' and 3000 values will be used
serve(dbFolder, dbFile, port);

An usage example can also be found in the example folder


Author