GRFreire/nthmail
1
0
Fork 0
mirror of https://github.com/GRFreire/nthmail.git synced 2026-01-09 12:59:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update getting started docs

Browse Source
This commit is contained in:
Guilherme Rugai Freire 2024-07-10 19:19:09 -03:00
parent 0fcd8083ff
commit 2cbbc67467
No known key found for this signature in database
GPG Key ID: AC1D9B6E48E16AC1
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -2,6 +2,39 @@
A temporary email service
## Getting Started
### Compiling
Requirements:
- Golang
- Templ
- Make
```sh
make
```
### Creating a database:
Requirements:
- SQLite
```sh
cat migration.sql | sqlite3 db.db
```
### Running:
Available env variables:
- WEB_SERVER_PORT
- MAIL_SERVER_PORT
- MAIL_SERVER_DOMAIN
```sh
./bin/server
```
## TODO
- Restart when either mail or web server dies