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

server-commons

v2.0.0

Published

Base Server for Node.js

Downloads

4

Readme

Server Commons

This project is used to create a new NodeJS Express server with use of ECMA6 Decorators, Configuration and Sequelize.

Environment Variables

  • DB_NAME: The database name
  • DB_USERNAME: The database user
  • DB_PASSWORD: The database password
  • DB_HOST: The database address
  • DB_PORT: The database port
  • VERBOSE: true if you want to log SQL Statements
  • DB_DIALECT: Can be mysql, postgres, mariadb
  • DB_SOCKET_PATH: If you want to use socket path
  • SYNC: True to auto generate the database
  • DB_MAX_CONCURRENT_QUERIES: Max concurrent queries
  • DB_POOL_MAX_CONNECTIONS: Max connections to keep on pool
  • DB_POOL_MIN_CONNECTIONS: Min connections to keep on pool
  • DB_POOL_MAX_IDLE_TIME: Max connections idle

How to use it

To use this project you need to pull the following project with the kickstart of a server

Models

In Domain Driven Development, we can also call it Repository. How to use it.

Routers

These are the Resources, the REST API. For example this:

import { RestController, GET, POST, PUT, DELETE } from 'base-server/router';
import { NotFoundError } from 'base-server/errors';
import AddressService from '../services/AddressService';
import AddressModel from '../models/AddressModel';

@RestController('/address')
export default class AddressRouter {

  @GET('/:uuid')
  async findAddress({ params }) {
    const address = await AddressModel.find(params.uuid);
    if (!address) throw new NotFoundError('Address not Found');
    return address;
  }

  @POST('/')
  async createAddress({ body }) {
    const address = await AddressService.create(body);
    return AddressModel.find(address.uuid);
  }

  @PUT('/:uuid')
  async updateAddress({ params, body }) {
    await AddressService.update(params.uuid, body);
  }

  @DELETE('/:uuid')
  async deleteAddress({ params }) {
    await AddressService.deleteAddress(params.uuid);
  }

}

Sequelize

They are the Entities, the objects that are persisted on the database

import { DataTypes } from 'sequelize';
import State from './State';

const { BIGINT, STRING } = DataTypes;

const City = sequelize.define('City', {
  id: { type: BIGINT, primaryKey: true, autoIncrement: true },
  name: { type: STRING(256), allowNull: false },
}, {
  timestamps: false,
  tableName: 'city'
});

City.belongsTo(State, {
  as: 'State',
  foreignKey: 'state_id'
});

export default City;

Services

They have to keep the business logic

index.js

import Server from 'base-server/server';
import { join } from 'path';

const server = new Server({
  migration: {
    name: 'pipeu-event-schedule',
    dir: join(__dirname, '..', 'db'),
  },
});

// add requires to all your routers (compatible with Babel+Webpack)
require('./routers/MyRouter');

export default server;