Skip to content

nvkhanh/search_git_user

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

GitHub Search

This is a demo for Flutter project, it help user can find someone on github and find some user's information

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes

How to use

Download or clone this repo by using the link below

Step 1:

Download or clone this repo by using the link below:

https://github.com/nvkhanh/search_git_user

Step 2:

Go to project root and execute the following command in console to get the required dependencies:

flutter pub get 
flutter run

Search Features:

  • Search a user with username
  • See user's information

Libraries & Tools Used

Folder Structure

Here is the folder structure we have been using in this project

lib/
|- data/
  |- models/
  |- repositories/
|- domain/
  |- entities/
  |- repositories/
  |- usecase/
|- presentation/
  |- bloc/
  |- pages/
|- helpers/
|- main.dart

Now, lets dive into the lib folder which has the main code for the application.

1- data - Contains the data layer of your project, includes directories for local, network and shared pref/cache.
2- domain - Contain the bussiness logic and link the data layer to presentation layer. 
3- presentation — Contains all the ui of your project, contains sub directory for each screen and state management in this project.
4- helpers — Contains the utilities/common functions of your application.
5- widgets — Contains the common widgets for your applications
6- main.dart - This is the starting point of the application. All the application level configurations are defined in this file i.e, theme, routes, title, orientation etc.

Presentation

This directory contains all the ui of your application. Each screen is located in a separate folder making it easy to combine group of files related to that particular screen. All the screen specific widgets will be placed in widgets directory as shown in the example below:

presentation/
|- search_page
   |- search_page.dart
   |- widgets

Helpers

Contains the common file(s) and utilities used in a project. The folder structure is as follows:

helpers/
|- utils.dart

Main

This is the starting point of the application. All the application level configurations are defined in this file i.e, theme, routes, title, orientation etc.

Conclusion

I will be happy to hear any feedback from you, and if you want to lend a hand with the project then please feel free to submit an issue and/or pull request

Demo

Screen.Recording.2023-02-14.at.14.55.20.mov

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published