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

@pennlabs/kraken

v0.8.12

Published

cdkactions construct abstractions built for Penn Labs

Downloads

231

Readme

kraken

A cdk library for cdkactions.

Documentation

See Kraken documentation.

Getting started

When creating a new project, do the following:

  • Follow the cdkactions getting started guide to initialize the cdkactions project.
  • Run yarn install @pennlabs/kraken
  • Configure cdkactions (See the following subjections)
  • Finally, run yarn build within the .github/cdk folder and commit your changes.

Django + React Project

Most Penn Labs products follow the mold of a Django project in the backend directory and a React project in the frontend directory.

Since this is a common use-case, kraken provides an LabsApplicationStack that can easily configure the CI for this type of project.

To use an LabsApplicationStack stack, just replace the generated stack with:

new LabsApplicationStack(app, {
  djangoProjectName: 'exampleDjangoProject',
  dockerImageBaseName: 'example-product',
});

This configuration will lint, test, build, publish docker images for, and deploy both the Django project and a React project. The published docker images will be named: $dockerImageBaseName-backend and $dockerImageBaseName-frontend

Different Configuration

If your repo is different from the normal 1 Django and 1 React project per repo, you can utilize the DjangoProject and ReactProject classes. For example, if you had a single Django project with multiple frontends, you could add something like the following inside of the generated Stack:

const workflow = new Workflow(this, 'workflow', {
  name: 'Workflow',
  on: 'push',
});

const django = new DjangoProject(workflow,
  {
    projectName: 'djangoProject',
    path: 'backend',
    imageName: 'project-backend',
  });

const reactOne = new ReactProject(workflow,
  {
    id: 'one',
    path: 'frontendOne',
    imageName: 'project-frontendOne',
  });

const reactTwo = new ReactProject(workflow,
  {
    id: 'two',
    path: 'frontendTwo',
    imageName: 'project-frontendTwo',
  });

new DeployJob(workflow, {},
  {
    needs: [django.publishJobId, reactOne.publishJobId, reactTwo.publishJobId],
  });

This configuration will lint, test, build, publish docker images for the Django project as well as the two React projects and then finally deploy the application.