mirror of
https://github.com/GRFreire/nthmail.git
synced 2026-01-10 13:29:37 +00:00
update getting started docs
This commit is contained in:
parent
0fcd8083ff
commit
2cbbc67467
33
README.md
33
README.md
@ -2,6 +2,39 @@
|
|||||||
|
|
||||||
A temporary email service
|
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
|
## TODO
|
||||||
|
|
||||||
- Restart when either mail or web server dies
|
- Restart when either mail or web server dies
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user