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

@conclurer/edelog-portal-server

v1.5.1

Published

Provides a microservice for hosting an Edelog portal that can be managed using Edelog's Portal Builder

Downloads

4

Readme

Edelog Portal Server

This package contains the basic foundation of Edelog Portal Server. Microservices using this package are intended to be managed by Edelog Portal Builder but it can also function standalone.

Setup

In order to use Edelog Portal Server you have to register a manually deployed portal using Portal Builder.

Create a js file that will functioning as entry point for the server.

Example:

import providePortalServer from '@conclurer/edelog-portal-server';

providePortalServer({
  portalAccessId: '',
  portalAccessSecretKey: '',
  edelogApiBaseUrl: 'https://app.edelog.com/',
  portalBuilderApiBaseUrl: 'https://pb.industrial.edelog.com/',
  expressConfig: {
    port: 4000,
  },
});

You can also omit these variables and fallback to the corresponding ENV vars: EDELOG_API_BASE_URL, PORTAL_BUILDER_API_BASE_URL, PORTAL_ACCESS_ID, PORTAL_ACCESS_SECRET_KEY and PORT.

Project Structure

Your project folder is expected to have this format:

- index.js (*)
- locales
    - de.json
    - en.json
    - ...
- static
    - index.html (*)
    - ...

The files with (*) are required.

The locales folder contains locale overwrites. By default, Edelog Portal Server will fallback to Edelog's language files. If you specify a language file, you can partially overwrite some language strings.

Language strings are specified in the following way (example en.json):

{
  "en": {
    "next": {
      "buttons": {
        "save": "Overwritten Label"
      }
    }
  }
}

The static folder contains the html files for the frontend of the portal. When being automatically deployed, Edelog Portal Builder will create a build of Edelog Portal Frontend using the following command:

ng build --prod=true --aot=true --buildOptimizer=true --deployUrl=/static/

Edelog Portal Server's underlying Express configuration will redirect any non-matching request to static/index.html.

Usage

To start the server, simply run node index.js (assuming index.js is your main file).