Skip to content

Commit 88be0d8

Browse files
authored
Update README.md (#8)
1 parent 7d4be52 commit 88be0d8

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Subscriber Project
2+
3+
This project is designed to help manage subscribers.
4+
5+
### Using Docker Compose
6+
7+
Here is an example of how to use Docker Compose with this project.
8+
9+
```yaml
10+
version: '3.8'
11+
12+
services:
13+
subscriber:
14+
image: ghcr.io/sparx-foundation/subscriber:latest
15+
build:
16+
context: .
17+
dockerfile: Dockerfile
18+
ports:
19+
- "8080:8080"
20+
environment:
21+
SMTP_NAME=your_smtp_name
22+
SMTP_PASS=your_smtp_password
23+
SMTP_HOST=your_smtp_host
24+
DATABASE_URL=your_database_url
25+
SERVER_PORT=your_server_port
26+
ALLOWED_ORIGINS=origin1,origin2,origin3
27+
28+
# Add any additional services here (like psotgres)
29+
postgres:
30+
image: postgres:latest
31+
environment:
32+
POSTGRES_DB: your_database_name
33+
POSTGRES_USER: your_database_user
34+
POSTGRES_PASSWORD: your_database_password
35+
volumes:
36+
- postgres_data:/var/lib/postgresql/data
37+
ports:
38+
- "5432:5432"
39+
40+
volumes:
41+
postgres_data:
42+
```
43+
44+
### Running the Application
45+
46+
Once the containers are up and running, you can access the application by navigating to `http://localhost:8080` in your web browser.
47+
48+
### Contributing
49+
50+
If you would like to contribute to this project, please fork the repository and submit a pull request.
51+
52+
### License
53+
54+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
55+

0 commit comments

Comments
 (0)