Local Setup

This guide will walk you through setting up the API server in a local development environment.

1. Prerequisites

   Ensure you have the following software installed on your system:

   • Dart SDK: Version 3.0.0 or higher.
   • MongoDB: Version 5.0 or higher is recommended.
   • Dart Frog CLI: Install it globally by running:

     dart pub global activate dart_frog_cli

2. Download the Latest Release

   Download the source code of the latest release from the GitHub releases page for the API Server:

   • API Server: https://github.com/flutter-news-app-full-source-code/flutter-news-app-api-server-full-source-code/releases/latest

   After downloading and extracting the archive, navigate into the project directory.

3. Set Up Local Database

   The API server requires a MongoDB database. For local development, the recommended approach is to use Docker.

   Tip

   For a complete walkthrough, follow the Configure MongoDB for Local Development guide.

4. Configure Environment Variables

   The server uses a .env file to manage secrets and configuration. You will need to create this file and populate it with the correct values for your local environment.

   Tip

   For a detailed walkthrough, follow the Configure Environment Variables guide.

5. Install Dependencies

   Navigate to the server’s root directory and fetch the required Dart packages:

   dart pub get

6. Run the Development Server

   Start the Dart Frog development server:

   dart_frog dev

   Note

   The API will now be running and available at http://localhost:8080.