dart-frog-dev / dart_frog

[![Dart Frog Logo][logo_white]][dart_frog_link_dark] [![Dart Frog Logo][logo_black]][dart_frog_link_light] [![discord][discord_badge]][discord_link] [![dart][dart_badge]][dart_link] [![ci][ci_badge]][ci_link] [![coverage][coverage_badge]][ci_link] [![style: dart frog lint][dart_frog_lint_badge]][dart_frog_lint_link] [![License: MIT][license_badge]][license_link] A fast, minimalistic backend framework for Dart 🎯 [Originally developed][credits_link] by [Very Good Ventures][very_good_ventures_link] 🦄 Documentation 📝 For official documentation, please visit https://dart-frog.dev. Packages 📦 | Package | Pub | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | dart_frog | | | dart_frog_auth | | | dart_frog_cli | | | dart_frog_gen | | | dart_frog_lint | | | dart_frog_test | | | dart_frog_web_socket | | Quick Start 🚀 Prerequisites 📝 In order to use Dart Frog you must have the [Dart SDK][dart_installation_link] installed on your machine. Installing 🧑‍💻 Creating a Project ✨ Use the command to create a new project. Start the Dev Server 🏁 Next, open the newly created project and start the dev server via: 💡 **Tip**: By default port is used. A custom port can be used via the option. Create a Production Build 📦 Create a production build which includes a so that you can deploy anywhere: Create New Routes and Middleware 🛣️ To add new routes and middleware to your project, use the command. Goals 🎯 Dart Frog is built on top of shelf and mason and is inspired by many tools including remix.run, next.js, and express.js. The goal of Dart Frog is to help developers effectively build backends in Dart. Currently, Dart Frog is focused on optimizing the process of building backends which aggregate, compose, and normalize data from multiple sources. Dart Frog provides a simple core with a small API surface area in order to reduce the learning curve and ramp-up time for developers. In addition, Dart Frog is intended to help Flutter/Dart developers maximize their productivity by having a unified tech stack that enables sharing tooling, models, and more! Extensions 💻 • VSCode: extends VSCode with support for Dart Frog and provides tools for effectively managing Dart Frog projects within VSCode. [ci_badge]: https://github.com/dart-frog-dev/dart_frog/actions/workflows/main.yaml/badge.svg [ci_link]: https://github.com/dart-frog-dev/dart_frog/actions/workflows/main.yaml [credits_link]: https://github.com/dart-frog-dev/dart_frog/blob/main/CREDITS.md#acknowledgments [coverage_badge]: https://raw.githubusercontent.com/dart-frog-dev/dart_frog/main/packages/dart_frog/coverage_badge.svg [dart_badge]: https://img.shields.io/badge/Dart-%230175C2.svg?style=for-the-badge&logo=dart&logoColor=5BB4F0&color=1E2833 [dart_link]: https://dart.dev [dart_frog_link_dark]: https://github.com/dart-frog-dev/dart_frog#gh-dark-mode-only [dart_frog_link_light]: https://github.com/dart-frog-dev/dart_frog#gh-light-mode-only [dart_frog_lint_badge]: https://img.shields.io/badge/style-dart_frog_lint-1DF9D2.svg [dart_frog_lint_link]: https://pub.dev/packages/dart_frog_lint [dart_installation_link]: https://dart.dev/get-dart [discord_badge]: https://img.shields.io/discord/1394707782271238184?style=for-the-badge&logo=discord&color=1C2A2E&logoColor=1DF9D2 [discord_link]: https://dart-frog.dev/discord [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg [license_link]: https://opensource.org/licenses/MIT [logo_black]: https://raw.githubusercontent.com/dart-frog-dev/dart_frog/main/assets/dart_frog_logo_black.png#gh-light-mode-only [logo_white]: https://raw.githubusercontent.com/dart-frog-dev/dart_frog/main/assets/dart_frog_logo_white.png#gh-dark-mode-only [very_good_ventures_link]: https://verygood.ventures