tcp-wiki/README.md
2023-04-12 06:29:36 -06:00

1.7 KiB

H0wdy!!!

feel free to commit, leave suggestions, issues, or really anything <3

SETUP

For a normal user you can follow this process:

First clone the repo:

git clone https://git.tcp.direct/S4D/tcp-wiki.git

Then you have to cd into the repo's folder and run/compile:

cd tcp-wiki/src
go run .

Then you goto your browser and visit: http://127.0.0.1:8080/

For a develeper setup you can follow this process:

First clone the repo:

git clone ssh://git@git.tcp.direct:2222/S4D/tcp-wiki.git

Then cd and run dev.sh

cd tcp-wiki
bash dev.sh

Then you goto your browser and visit: http://127.0.0.1:8080/

This method just adds in some handy symlinks for development purposes

Use with your own repo?

All you have to do is modify the main.go file:

const repoURL = "https://git.tcp.direct/S4D/tcp-wiki.git"

Change this line to your repo link, and enjoy!

TODO

  • MANY FUCKING THINGS
  • Webhook support for auto pull on push/update of the git repo
  • Git Branch support
  • add a star/upvote/like feature for pages
  • edit tracker
    • Author
    • last edited
    • last editor/commit
  • pgp signed intergration
  • comments using bitcask - generated in comments.db/
    • verification - no login pgp
    • captcha
    • sub rating system
    • sort by date etc
    • reply to replies
    • set security controls per page
  • dynamically generated links for all avaiable pages
    • sitemap
    • anti robot shit here
    • acual working pages!?
  • post quantum intergration and verification
  • BUILD UP THAT MARKDOWN SUPPORT
  • fix whatever i did to fuck up design/layout/css???