aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorgrant-kun <[email protected]>2022-10-31 09:56:36 -0500
committergrant-kun <[email protected]>2022-10-31 09:56:36 -0500
commitb79f3023b3c604a682ff1e3e385c4a40f6f1d978 (patch)
treefbc73f7b212fb1d89f363d6f36a12f161ae153d2 /readme.md
parent032266f5db33a95af25ee81d8beba74ac68858da (diff)
update
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md31
1 files changed, 19 insertions, 12 deletions
diff --git a/readme.md b/readme.md
index 6c6db7e..b6ecdc6 100644
--- a/readme.md
+++ b/readme.md
@@ -16,29 +16,34 @@ create generic keys `openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout
### running
-#### windows
-
dependencies:
-- [ ] ts-node |`npm i -g ts-node`
+- ts-node |`npm i -g ts-node`
+- package.json | `npm i`
+- development (optional)
+ - nodemon | `npm i -g nodemon`
+
+
+#### windows
-run `npm i` & `npm start`
+main build : `npm start`
+
+dev : `npm run dev`
---
#### \*nix
-dependencies:
+###### please note, for linux you will need to run this as root (for permission to use these ports, 80,443)
-- [ ] ts-node |`sudo npm i -g ts-node`
+main build : `sudo ts-node .`
-run `npm i` & `sudo ts-node .`
+dev : `sudo nodemon .`
----
-<sub>kanna was here</sub>
+---
-visit the [main git](https://git.disroot.org/grantsquires/kanna-site) or the [github](https://github.com/squiresgrant/kanna-site)
+[gitea](https://git.disroot.org/grantsquires/kanna-site) | [github](https://github.com/squiresgrant/kanna-site)
## todo
@@ -63,6 +68,7 @@ visit the [main git](https://git.disroot.org/grantsquires/kanna-site) or the [gi
- [ ] option to markdownify email
- [ ] write md emails, send as html
- [ ] sexify
+ - [ ] settings.json
- [ ] make mail prettier
- [ ] dont accept old login keys
- [ ] add functionality
@@ -76,7 +82,7 @@ visit the [main git](https://git.disroot.org/grantsquires/kanna-site) or the [gi
- [ ] sender info
- [ ] allow for email account adding
- [ ] docs
- - [ ] extra pages
+ - [x] extra pages
- [x] 404 page
- [ ] sub domains
- [ ] ughh hate sub domains
@@ -87,10 +93,11 @@ visit the [main git](https://git.disroot.org/grantsquires/kanna-site) or the [gi
- [ ] more sexy gradients (everywhere)
- [ ] lower verbosity (and options to change it)
- [ ] move all dependencies to local ones
+ - [ ] check for permissions on what ports to open
### issues
- [x] storage not saving
- - [ ] check for login key cookie on page loads
+ - [ ] check for login key cookie on page load
FeMail (iron mail)