Skip to content

Commit 9d38b28

Browse files
committed
feat: fix docs
1 parent a871ea1 commit 9d38b28

14 files changed

Lines changed: 77 additions & 851 deletions

pages/_meta.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ export default {
33
"introduction": "Introduction",
44
"howitworks": "How it works",
55
"quickstart": "Quickstart",
6-
"installation": "Installation",
76
"support": "Support",
87
"developer-guide": "Developer Guide"
98
};

pages/developer-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ It makes it easier to develop and deploy the project.
2929

3030
### Frontend
3131

32-
The frontend is built with [NextJS](https://nextjs.org/) and [TailwindCSS](https://tailwindcss.com/).
32+
The frontend is built with React Router and [TailwindCSS](https://tailwindcss.com/).
3333

3434
### Backend
3535

pages/howitworks.mdx

Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 'Learn the architecture of the project'
55

66
## Architecture
77

8-
GrowChief is composed of 4 main services and 3 external services - all 4 of the main services typically run within a **single docker container**, and talk to each other through HTTP. Those 4 main servers typically talk to other containers, running the external services - the SQL Database, Redis Queue and Storage.
8+
GrowChief is composed of 3 main services and 2 external services - all 5 of the main services typically run within a **single docker container**, and talk to each other through HTTP. Those 4 main servers typically talk to other containers, running the external services - the SQL Database, Redis Queue and Storage.
99

1010
```mermaid
1111
flowchart LR;
@@ -14,58 +14,33 @@ flowchart LR;
1414
1515
frontend[Frontend Service]:::svc
1616
backend[Backend Service]:::svc
17-
cron[Cron Service]:::svc
18-
workers[Worker Service]:::svc
19-
redis[Redis Queue]:::ext
20-
db[SQL Database]:::ext
21-
storage[Storage]:::ext
17+
orchestrator[Temporal Worker]:::svc
18+
temporal[Temporal Service]:::ext
19+
postgres[Postgres Database]:::ext
2220
2321
frontend --> backend
24-
backend --> db
25-
backend --> redis
26-
cron <--> redis
27-
workers --> storage
28-
workers --> db
29-
redis --> workers
30-
backend --> storage
31-
22+
backend --> postgres
23+
backend --> temporal
24+
orchestrator --> temporal
25+
orchestrator --> postgres
3226
```
3327

3428

3529
- [Frontend](#frontend) - Provides the Web user interface, talks to the Backend.
3630
- [Backend](#backend) - Does all the real work, provides an API for the frontend, and posts work to the redis queue.
37-
- [Workers](#worker) - Consumes work from the Redis Queue.
38-
- [Cron](#cron) - Run jobs at scheduled times.
31+
- [Workers](#worker) - Consumes work from the Temporal Service.
3932

40-
- [Redis Queue](#redis) - A simple queue for the workers to consume work from.
33+
- [Temporal Service](#temporal) - A simple queue for the workers to consume work from.
4134
- [SQL Database](#db) - Stores all the data, Postgres is typically used, but any SQL database can be used.
42-
- [Storage](#storage) - Stores all the files, this used to be CloudFlare R2 as the default, but now it's just a local file system.
4335

4436
### Frontend
4537

46-
The frontend is the part that you see, the web interface.
47-
48-
It relies on the backend to:
49-
50-
- Schedule posts
51-
- Show analytics
52-
- Manage users
38+
The frontend is the part that you see, the web interface make with React Vite.
5339

5440
### Backend
5541

5642
The backend is the "brain" of GrowChief, and coordinates all the work. Typically the SQL database it talks to is Postgres, but other databases can be used.
5743

58-
### Cron
59-
60-
The cron service does the following;
61-
62-
- Refresh tokens from different social media platforms.
63-
- Check for trending change every hour and inform users about it.
64-
- Sync the amount of stars for every repository at the end of the day.
65-
6644
### Worker
6745

68-
The worker services does the following;
69-
70-
- Post scheduled posts to social media platforms.
71-
- Perform multiple jobs coming from the cron.
46+
The worker process the queue and automate your social media accounts.

pages/installation/_meta.js

Lines changed: 0 additions & 7 deletions
This file was deleted.

pages/installation/coolify.mdx

Lines changed: 0 additions & 143 deletions
This file was deleted.

pages/installation/devcontainer.mdx

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)