HOW_TO.md

How To

Onix Project Generator

• Create a new project

Generated project

• Architecture overview
• How BLoC state management works in generated project
• How networking component works in generated project
• Where flavor main files are located in?
• Where API client base components are located in?
• How I can add new failure types?

Where flavor main files are located in?

Main files are located in:

lib/app/flavors

Where API client base components are located in?

Base API client components are located in:

lib/core/arch/data/remote

Here you can find all the base classes which that are included in the API client module.

Base API url and API client name are located in:

lib/core/arch/data/remote/dio/dio_const.dart

You free to add as much URls you need and declare a new API clients to use with different urls.

Also here a few examples of request interceptors in /interceptor folder. You can use any you like or your own implementation but not forgot to declare chosen interceptor in the ApiClient.

How I can add new failure types?

Just go to lib/core/arch/domain/entity/failure folder and create any much new custom failures you need. But be aware that you new failure classes must implement base Failure class.

Have a question? Don't be shy to contact us via GitHub.