https://github.com/supercharge/framework
The Supercharge core code
https://github.com/supercharge/framework
framework hacktoberfest nodejs supercharge
Last synced: 6 months ago
JSON representation
The Supercharge core code
- Host: GitHub
- URL: https://github.com/supercharge/framework
- Owner: supercharge
- License: mit
- Created: 2019-01-28T19:43:29.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T11:32:47.000Z (over 1 year ago)
- Last Synced: 2025-03-29T02:05:21.472Z (7 months ago)
- Topics: framework, hacktoberfest, nodejs, supercharge
- Language: TypeScript
- Homepage: https://superchargejs.com
- Size: 2.87 MB
- Stars: 23
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Supercharge is an open-source Node.js framework
making your server-side development enjoyable.
Framework Development ·
Resources
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](https://github.com/superchargejs/supercharge) when building a Supercharge app.
## Framework Development
The framework is structured as a [Lerna](https://lerna.js.org/) 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
```bash
git clone git@github.com:supercharge/framework.git
```
#### 2. Install NPM dependencies
```bash
npm install
```
#### 3. Build the packages
```bash
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/` 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.
```bash
npm test
```
#### Testing a Single Package
Let’s take the `logging` package as an example. You can test the logging package like this:
```bash
cd packages/logging
npm test
```
## Resources
- [Documentation](https://superchargejs.com/docs)
- [App Boilerplate](https://github.com/supercharge/supercharge)
## License
Supercharge is [MIT licensed](https://github.com/supercharge/framework/blob/2.x/LICENSE).
---
> [superchargejs.com](https://superchargejs.com) ·
> GitHub [@supercharge](https://github.com/supercharge/) ·
> Twitter [@superchargejs](https://twitter.com/superchargejs)