full-stack-community-template/README.MD.erb at main · flatlogic/full-stack-community-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# Project Setup & Local Development

## Tech Stack

| Layer     | Technology           |
| --------- | -------------------- |
| Front‑end | **React JS**         |
| Back‑end  | **Node JS**          |
| Database  | **PostgreSQL**       |
| Container | **Docker & Compose** |

---

## 1 — Run Locally (without Docker)

### 1.1 Backend

```bash
cd backend
# install dependencies
yarn install
```

\#### Configure PostgreSQL

<details>
<summary><strong>macOS</strong></summary>

```bash
brew install postgres
```

</details>
<details>
<summary><strong>Ubuntu</strong></summary>

```bash
sudo apt update
sudo apt install postgresql postgresql-contrib
```

</details>

\##### Create DB & Admin User

```bash
# log in as default super‑user
psql postgres -U postgres

-- inside psql
CREATE ROLE admin WITH LOGIN PASSWORD 'admin_pass';
ALTER ROLE admin CREATEDB;
\q

# log in as the new user
psql postgres -U admin

-- inside psql
CREATE DATABASE db_<your_project_name>;
GRANT ALL PRIVILEGES ON DATABASE db_<your_project_name> TO admin;
\q
```

\##### Migrate & Start

```bash
yarn db:create   # generate schema
yarn start       # production build
```

### 1.2 Frontend

```bash
cd frontend
yarn install
yarn start
```

> Front‑end dev‑server runs at **[http://localhost:3000](http://localhost:3000)** by default.

---

## 2 — Run with Docker

```bash
cd docker
chmod +x wait-for-it.sh start-backend.sh
```

| Scenario                  | Command                            |
| ------------------------- | ---------------------------------- |
| **Fresh DB volume**       | `rm -rf data && docker-compose up` |
| **Reuse existing volume** | `docker-compose up`                |

Then open **[http://localhost:3000](http://localhost:3000)**.

Stop services with **Ctrl + C** or:

```bash
docker-compose down
```

> **Heads‑up:** Files inside the `docker/` folder and the root `Dockerfile` are used for cloud deployment. Changing them may break the pipeline.

---

## Folder Structure (top‑level)

```text
├── backend/          # Node JS API & services
├── frontend/         # React application
├── docker/           # Compose files & helper scripts
└── README.md         # (this file)
```

---

## Troubleshooting

### “connection refused”

1. Port closed or backlog full.
2. Firewall (local or network).
3. Service not running.

Verify with:

```bash
telnet <host> <port>
```

### macOS

```bash
sudo service ssh status
```

### Ubuntu – IP conflict check

```bash
arp-scan -I eth0 -l | grep <ipaddress>
arping <ipaddress>
```

### Reset PostgreSQL schema (macOS example)

```sql
DROP SCHEMA public CASCADE;
CREATE SCHEMA public;
GRANT ALL ON SCHEMA public TO postgres;
GRANT ALL ON SCHEMA public TO public;
```

---

## Cheat‑sheet

| Task                    | Command                            |
| ----------------------- | ---------------------------------- |
| **Create DB schema**    | `yarn db:create`                   |
| **Start backend**       | `yarn start`                       |
| **Start dev front‑end** | `cd frontend && yarn start`        |
| **Compose up (fresh)**  | `rm -rf data && docker-compose up` |
| **Compose down**        | `docker-compose down`              |

<br/>

---

Made with ❤️ by Flatlogic Platform.