# flutter_web_fullstack_boileplate

**Repository Path**: byself/flutter_web_fullstack_boileplate

## Basic Information

- **Project Name**: flutter_web_fullstack_boileplate
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-24
- **Last Updated**: 2023-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h3 align = "center"> Dockerized Flutter(web) + Golang(Gin) + PostgreSQL(with GORM) + Redis --> Template  </h1>

#

<br>
<p align = "center">
  <i>
    This repository is a fully dockerized application, which by default is a <b>web</b> app, but modyfing Dockerfiles lets to run it on <b> mobile </b> device too. 
    Front-end is written in <b> Flutter </b>, Back-end in <b> Golang with Gin </b> framework. Databases are <b> PostgreSQL (with GORM) </b> and <b> Redis ( Redigo )</b>. Reverse proxy with <b> Nginx </b>. It contains simple CRUD functions for both, Postgresql and Redis. Back-end is finished, Front-end has only fetch functions implemented.
  </i>
</p>

<br/>

---

<p align="center">
  Found it useful? Want more updates?
</p>

<p align = "center">
  <b> <i> Show your support by giving a :star: </b> </i>
</p>

---

</br>

## How to launch it locally?

### <a href ="https://www.youtube.com/watch?v=DzhjvyByvIs&feature=youtu.be&ab_channel=WiktorZaj%C4%85c">  Here is a video showing how to work with this repository </a>

Note the difference in containers name on the video - `fggp` was updated to `flutter_web_fullstack_boilerplate` 

You can also ue instructions below.

<br/>

<b> 1. </b> Make sure that you have `docker` and `docker-compose` installed on your machine.

<br/>

<b> 2. </b> Clone the repository to the folder of your choice, by executing: `git clone hhttps://github.com/wzslr321/flutter_web_fullstack_boileplate.git` in the console.

<br/>

<b> 3. </b> Navigate to  `"/"` path of cloned repository. To ensure that you are in a right place, run `ls`. Outpout should look like this:

> LICENSE  README.md  all_lint_rules.yaml  analysis_options.yaml  app  data  docker-compose.yml  env  nginx  server


#### 4.  Run : <b> `docker-compose up --build` </b> in the console.

<br/> 

<b> 5. </b> Wait for the docker installation to complete. It probably is going to take some time, depending on your internet connection.

<br/> 

When the installation will be finished, you should see this output:
![img](https://user-images.githubusercontent.com/59893892/104651401-e1aac080-56b7-11eb-8c85-a449ee4cb6c0.png)

<br/>

#### Now just head to the `http://0.0.0.0/#/` in the browser too see the website!



### Project tree ( without meaningless files)
```bash
|├── all_lint_rules.yaml
├── analysis_options.yaml
├── app
│   ├── 
│   ├── assets
│   │   ├── fonts
│   │   └── images
│   ├── Dockerfile
│   ├── lib
│   │   ├── components
│   │   │   └── form
│   │   │       ├── form.dart
│   │   │       └── form_field.dart
│   │   ├── constants.dart
│   │   ├── main.dart
│   │   ├── models
│   │   │   ├── announcements
│   │   │   │   ├── announcement_class.dart
│   │   │   │   └── announcement_list.dart
│   │   │   ├── http_exception.dart
│   │   │   ├── posts
│   │   │   │   ├── post_class.dart
│   │   │   │   ├── post_id_response.dart
│   │   │   │   └── posts_list.dart
│   │   │   └── provider_exception.dart
│   │   ├── providers
│   │   │   ├── announcements_provider.dart
│   │   │   └── posts_provider.dart
│   │   └── screens
│   │       ├── announcements_screen
│   │       │   ├── announcements_screen.dart
│   │       │   └── widgets
│   │       │       ├── announcement_field.dart
│   │       │       └── announcement_item.dart
│   │       ├── home_screen
│   │       │   └── home_screen.dart
│   │       ├── loading_screen.dart
│   │       ├── page_not_found_screen
│   │       │   └── page_not_found.dart
│   │       └── posts_screen
│   │           ├── posts_screen.dart
│   │           └── widgets
│   │               ├── post_field.dart
│   │               └── post_item.dart
│   ├── pubspec.yaml
│   ├── README.md
│   └── web
│       ├── index.html
│       └── manifest.json
├── docker-compose.yml
├── env
│   ├── flutter.env
│   └── postgre.env
├── nginx
│   ├── Dockerfile
│   └── nginx.conf
└── server
    ├── air.conf
    ├── conf
    │   └── app.ini
    ├── database
    │   ├── postgres
    │   │   ├── funcs
    │   │   │   └── posts.go
    │   │   └── postgres.go
    │   └── redis
    │       ├── funcs
    │       │   ├── announcements.go
    │       │   └── majors.go
    │       └── redis.go
    ├── Dockerfile
    ├── main.go
    ├── main_test.go
    ├── models
    │   ├── announcement.go
    │   └── post.go
    ├── routers
    │   ├── api
    │   │   ├── announcements.go
    │   │   └── posts.go
    │   └── router.go
    ├── settings
    │   └── settings.go


```