karx/2m2d
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Revise documentation

Browse source
This commit is contained in:
Yash Karandikar 2022-08-27 11:18:29 -05:00
parent d1d07343ca
commit 113b772703
2 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -7,17 +7,22 @@
Created because [the original tmtd](https://git.karx.xyz/c4TG1RL5_UN1T3D/tmtd) shows no signs of being production ready any time soon.
### How?
This project requires a running PostgreSQL database. Read [the ArchWiki entry for more info](https://wiki.archlinux.org/title/PostgreSQL).
This project requires you to [set up a PostgreSQL database](https://www.postgresqltutorial.com/postgresql-getting-started/).
Then, see `sample_config.toml` and provide the required values.
Then, see `sample_config.toml` and provide the required values.
The `TMTD_CONFIG` environment variable can be used to specify a custom config path, otherwise, 2m2d defaults to using `./config.toml`.
After that, it's just a simple `cargo run`. The `TMTD_CONFIG` environment variable can be used to specify a custom config path, otherwise, 2m2d defaults to using `./config.toml`.
After that, it's just a simple `cargo run`.
Make sure you're running the project from the top level, otherwise 2m2d will not be able to find templates and static files.
### When?
2m2d will probably be hosted once we get around to styling all the forms and adding a `+ Create` button to the homepage.
Once these things are done, 2m2d will be deployed.
TODO:
- [ ] implement task deletion
- [ ] implement user logout
### Who?

12
sample_config.toml
View file

@ -1,4 +1,8 @@
secret = "..." # Secret used for session cookies. MUST be secure and at least 64 bytes!
connection_string = "postgres://user:pass@host/database_name" # connection used for connecting to postgresql
template_dir = "templates" # optional: directory where templates are stored. default: "./templates"
static_dir = "static" # optional: directory where static files are stored: default "./static"
# Secret used for hashing authentication session cookies. MUST be cryptographically secure and at least 64 bytes!
secret = "..."
# connection used for connecting to the postgresql database
connection_string = "postgres://user:pass@host/database_name"
# optional: directory where templates are stored. default: "./templates"
template_dir = "templates"
# optional: directory where static files are stored: default "./static"
static_dir = "static"