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

@boklisten/bl-admin

v1.10.6

Published

`bl-admin` is a administration tool for Boklisten.no. This README only describes development and technical detail. For a deep-dive into the application [please read our documentation](https://github.com/boklisten/bl-doc/blob/master/bl-admin/summary.md).

Downloads

4

Readme

bl-admin

bl-admin is a administration tool for Boklisten.no. This README only describes development and technical detail. For a deep-dive into the application please read our documentation.

Requirements

  • NodeJS v8.0 or higher
  • Typescript v3.0 or higher
  • NPM v6.14.0 or higher
  • bl-api v1.11.2 or higher

How to run

  1. Clone this repo to your own computer git clone https://github.com/boklisten/bl-admin
  2. Navigate into the newly created bl-admin folder
  3. Install npm modules npm i
  4. Ensure that bl-api is running on http://localhost:1337
    • No content will be available in bl-admin if bl-api is not running.
    • You will not be able to login if bl-api is not running.
  5. Start application locally with npm run watch
  6. You should now be able to view bl-admin on http://localhost:8080
    • the content will auto-update if you do changes to the code

Development

NPM scripts

npm run watch

Runs the application with angular --configuration set to local. You can view the application on localhost:8080.

npm run build

Builds the application with angular --configuartion set to the environment variable ANGULAR_ENV.

npm run build:prod

Builds the application with angular --configuartion set to production-nb.

npm run extract-i18n

Extracts all i18n tags from all the html files and puts them into three differnet xlf-file under ./src/locale.

npm run postinstall

This script used by the server on Heroku before hosting it.

Build files

There are a number of build files and settings files that are not purly from Angular. To develop bl-admin it is a good thing to know what they are.

./Procfile

The Procfile is the Heroku settings file. Your can read more about it here.

./xliffmerge.json

This is the settings file for i18n the translator ngx-i18nsupport. Read more.

./server.js

This is the server file. It is a script for running the bl-admin application on the heroku server. Very simple node+express script.

./src/hmr.ts

This file is for Angulars Hot Module Replacement. Read more.

Commit messages

We use the same commit message scheme as Anglular. You can read more about it here.

Versioning

bl-admin is versioned using semantic versioning meaning MAJOR.MINOR.PATCH. Ex: 1.9.3.

Branches

There are two main branches master and dev. You should use dev for all development and treat master as the public live version.

master

This branch should be treated as the production branch and should not have failing code.

When you push code to master the code is also pushed to our production environment on Heroku. Be aware that any commit you push to master will be viewable and executed on our live production server. The master branch is currently running on admin.boklisten.no.

You should always update the version when you push to master. Read more about versions

dev

This branch should be treated as a development branch, it should always be runnable but does not need to be at the same standard as master.

When you push to dev the code is also pushed to our dev environment on Heroku. The dev branch is currently running on bladmin.test.boklisten.no