Skip to content

Getting Started

This is a guide to help you get started with the project.

Prerequisites

Installation

There are two ways you can get started with the project:

1. Using the CLI

Install the CLI:

bash
dart pub global activate techshoi_app

Then create a new project:

bash
techshoi_app create -n my_app

Rename the .env.example file to .env and continue with the setup.

2. Manual

Clone the repository:

bash
git clone https://github.com/TechShoi/techshoi-app.git

Change the directory:

bash
cd techshoi-app

Install the dependencies:

bash
flutter pub get

Run code generation:

bash
flutter pub run build_runner build --delete-conflicting-outputs

Run pub get again to get the generated files:

bash
flutter pub get

Change app package name

bash
flutter pub run change_app_package_name:main com.new.package.name

Rename the .env.example file to .env and continue with the setup.

Run the project

Run the project:

bash
flutter run

Done!