Skip to content

Commit 52bdf9f

Browse files
committed
Add table of contents and self hot setup guide
1 parent 24cf884 commit 52bdf9f

3 files changed

Lines changed: 8 additions & 110 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Quick Start Guide 👉 [https://docs.httpsms.com](https://docs.httpsms.com)
1515

1616
<img width="1115" alt="header" src="https://user-images.githubusercontent.com/4196457/194767449-f12d84a0-22f1-4787-afb2-17398fb459f6.png">
1717

18+
## Table Of Contents
19+
1820
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1921
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2022

@@ -131,7 +133,7 @@ Android App-->>httpSMS API: [Async] Send result of sending SMS
131133
Android App-->>httpSMS API: [Async] Send Delivery Report
132134
```
133135

134-
## Local Setup - Docker
136+
## Self Host Setup - Docker
135137

136138
### 1. Setup Firebase
137139

@@ -202,21 +204,21 @@ GCP_PROJECT_ID=
202204

203205
### 5. Build and Run
204206

205-
Build and run the API, the web UI, database and cache using the `docker-compose.yml` file. It takes a while for build and download all the docker images.
206-
When it's finished, you'll be able to access the web UI at http://localhost:3000 and the API at http://localhost:8000
207+
- Build and run the API, the web UI, database and cache using the `docker-compose.yml` file. It takes a while for build and download all the docker images.
208+
When it's finished, you'll be able to access the web UI at http://localhost:3000 and the API at http://localhost:8000
207209

208210
```bash
209211
docker compose up --build
210212
```
211213

212214
### 6. Create the System User
213215

214-
The application uses the concept of a system user to process events async. You should manually create this user in `users` table in your database.
215-
Make sure you use the same `id` and `api_key` as the `EVENTS_QUEUE_USER_ID`, and `EVENTS_QUEUE_USER_API_KEY` in your `.env` file
216+
- The application uses the concept of a system user to process events async. You should manually create this user in `users` table in your database.
217+
Make sure you use the same `id` and `api_key` as the `EVENTS_QUEUE_USER_ID`, and `EVENTS_QUEUE_USER_API_KEY` in your `.env` file
216218

217219
### 7. Build the Android App.
218220

219-
Before building the Android app in [Android Studio](https://developer.android.com/studio), you need to replace the `google-services.json` file in the `android/app` directory with the file which you got from step 1. You need to do this for the firebase FCM messages to work properly.
221+
- Before building the Android app in [Android Studio](https://developer.android.com/studio), you need to replace the `google-services.json` file in the `android/app` directory with the file which you got from step 1. You need to do this for the firebase FCM messages to work properly.
220222

221223
## License
222224

api/README.md

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

web/README.md

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

0 commit comments

Comments
 (0)