Skip to main content

First Steps

Let's discover WinterFramework in less than 5 minutes.

Getting Started​

Get started by creating a new restAPI.

What you'll need​

  • Node.js version 22.0LTS or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • Bun version 1.2 or above:
    • When installing Bun, you are recommended to check all checkboxes related to dependencies.

Generate a new API​

Download the latest release of the project:

git clone https://github.com/Durukar/WinterFramework

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

After downloading, navigate to the backend folder and run the dependency installation command:

bun i or bun install

Start your API​

Run the server:

bun start

Your server run in http://localhost:1337/

⚠️ Prod port is 8080 dev port is 1337

FINALY​

Done! You now have a REST server and can start implementing controllers, services, and everything a good REST API can offer you.