Skip to content

supercharge/framework

Repository files navigation



Supercharge is an open-source Node.js framework
making your server-side development enjoyable.


Framework Development · Resources



Latest Version Monthly downloads

Follow @marcuspoehls and @superchargejs for updates!


Introduction

Supercharge is a full-stack Node.js framework — not just a web-framework or HTTP router.

The framework is written in TypeScript providing IntelliSense for all areas you’re interacting with the core.

Notice: This repository contains the code of the Supercharge framework. It provides the core functionality for your apps. It’s not the app boilerplate itself. Head over to the main Supercharge application repository when building a Supercharge app.

Framework Development

The framework is structured as a Lerna monorepo. It contains the required dependencies to create a local version on your computer.

Follow these steps to set up a local development environment for the framework:

1. Clone this repository

git clone git@github.com:supercharge/framework.git

2. Install NPM dependencies

npm install

3. Build the packages

npm run build

That’s it! You can start developing new features for the framework.

Testing Packages

Testing the framework is the combination of running the tests of each package. Each package in the framework has their own tests. You can run the full test suite by running the tests of each package or you can test individual packages. You don’t need to run tests from all packages when developing a feature.

Run tests for a selected package by navigating to the package directory cd packages/<package-name> and run npm test in the terminal:

Run All Tests

You can run all tests from the framework’s root directory unsing npm test. This triggers the tests of all packages.

npm test

Testing a Single Package

Let’s take the logging package as an example. You can test the logging package like this:

cd packages/logging
npm test

Resources

License

Supercharge is MIT licensed.


superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs