Skip to main content

FIRST APP GUIDE

Set Up Your Project

Before You Start

Make sure you've logged into the required services like described in Guide Overview.

Creating Your Project​

The codika create command is your gateway to professional Flutter development. It doesn't just create a basic Flutter project - it sets up a production-ready application with all the best practices and configurations you'd typically spend days implementing. This includes proper project structure, environment configurations, dependency management, and integration with essential development tools.

Let's get started! Start by running:

bash

codika create

You'll need to enter some basic app info and pick which features you want. For this guide, choose: Firebase, Markdown, Onboarding, Settings and Shorebird. We'll add the FAQ part later to show you how to expand your app.

Input Example

Here's what to enter when setting up your app:

bash

$ codika create

Building package executable... Built codika_cli:codika. ✓ Configuration file read successfully. (19ms)

═══════════════════════════════════════════════════════�����════ Application Configuration
════════════════════════════════════════════════════════════

Welcome to the Codika CLI! 🚀 We will guide you through setting up your project.

? What is the name of your app? ( default: My App ) Codika Starter App ? What is the name of your organisation? ( default: com.example ) io.codika ? Do you want to initialise Git in this project? (Y/n) Y ? What is the Git repository URL? Press enter to skip :
? Which environments do you want to create? [Development, Production]

════════════════════════════════════════════════════════════ Block Selection
════════════════════════════════════════════════════════════

? Include Authentication Block ? (y/N) N ? Include Branch Io Block ? (y/N) N ? Include Cloud Functions Block ? (y/N) N ? Include Faq Block ? (y/N) N ? Include Firebase Init Block ? (y/N) Y ? Include Images Block ? (y/N) N ? Include Markdown Reader Block ? (y/N) Y ? Include Mixpanel Block ? (y/N) N ? Include Notifications Block ? (y/N) N ? Include Onboarding Flow Block ? (y/N) Y ? Include Referral Block ? (y/N) N ? Include Settings Block ? (y/N) Y ? Include Shorebird Block ? (y/N) Y ? Include User Consent Block ? (y/N) N ? Include User Profile Block ? (y/N) N

What Just Happened ?​

When you ran codika create, our CLI did quite a bit of heavy lifting for you:

  • Created and configured Firebase projects for each environment
  • Set up Firestore database with the right security rules
  • Generated different app flavors using Flavorizr

What's Flavorizr?

Flavorizr is a Flutter tool that helps create different versions (flavors) of your app. This lets you have separate dev, stag and prod builds with different configurations, app icons, and names.

Run Your App​

Ready to see your app in action? If you're using VS Code, we've already set up the run configurations for you. Just:

  1. Open the Run and Debug panel (Ctrl/Cmd + Shift + D)
  2. Select DEV | Debug from the dropdown at the top
  3. Hit the play button or press F5

You can switch between the different environnement builds using the same dropdown.

What's Next?​

Nice work! You've got a solid foundation for your app with:

  • A working Firebase setup
  • Multiple environments configured
  • Basic features ready to customize

Let's move on to setting up your app distribution pipeline, where we'll configure automated builds and deployments.