Overview
Sarus is a lightweight backend framework for Dart, built on the top of Shelf with the modular approch.
Quick Start 🚀
In order to use Sarus you must have the Dart SDK installed on your machine.
Sarus requires Dart >=3.5.0 <4.0.0
Installing 🧑💻
dart pub global activate sarus_cli
Creating a Project ✨
Use the sarus create command to create a new Sarus project:
sarus create my_project
This will create a new directory called my_project with the basic structure of a Sarus project.
Running the Project
To run your Sarus project, navigate to the project directory and use the sarus dev command:
cd my_project
sarus dev
The cd command changes the directory you're working with. In order to work with your newly created Sarus project, you'll need to navigate the terminal there.
The sarus dev command builds your project locally and serves it through a development server, ready for you to view at http://localhost:8080/greeting.
Building for Production ⚙️
To build your Sarus project for production, use the sarus build command:
sarus build
Uninstalling 🗑️
To Uninstall Sarus globally via Pub, you need to run this command:
dart pub global deactivate sarus_cli