Skip to content

Commit

Permalink
meet Supercharge
Browse files Browse the repository at this point in the history
  • Loading branch information
marcuspoehls committed Sep 6, 2022
1 parent bb26f82 commit 0811633
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# Installation


## Meet Supercharge
Supercharge is a Node.js framework with a stylish, purposeful syntax. Supercharge as a web application framework provides the starting point for your project. It gives the structure for you to focus on creating your app.


### Supercharge Packages
[The Supercharge framework](https://github.com/supercharge/framework) consists of multiple core packages. All core packages are located inside the `packages` directory of the framework’s GitHub repository.

Each package provides a specific functionality, like the application instance, a configuration store, an IOC container, an HTTP server and router, the hashing and encryption services, and so on. Combining all packages in a structured way creates a Supercharge application.

Every release of the framework’s core packages have the same version number. Using the same version for core packages reduces the cognitive load in your application because you can bump all packages to the same version without worrying if releases work together or if you need to bump another package, too.

Here’s an example: when we tag a release version `3.8.0` for `@supercharge/core`, you’ll find the same `3.8.0` release for all other core packages (like `@supercharge/http`, `@supercharge/session`, `@supercharge/view`, and so on) as well.


### Using TypeScript
Supercharge is written in TypeScript. Writing the framework in TypeScript automatically creates type definitions. These type definitions allow your code editor or IDE to provide IntelliSense. Using IntelliSense as a way for automatic code suggestions increases your productivity because you don’t need to look up all available methods and functionalities. Your editor or IDE could also show errors right in front of you while working on code.


### Developer Experience
We’re striving to provide a delicious developer experience. You’ll notice that most of the time the framework provides a handy method for basic functionality you would need to build yourself in other frameworks. Also, we usually return an instance of `this` from methods allowing you to create fluent method chains. You’ll recognize fluent methods when working with the framework.


## System Requirements
The Supercharge framework has some system requirements. Ensure that your system has the following dependencies installed:

Expand Down

0 comments on commit 0811633

Please sign in to comment.