Self Study Wiki (sswiki)
💡 To create a platform that combines the power of search engines with concept of wikis
The end goal of this platform is to effectively link resources to "complex" topics -- e.g. quantum physics, ctf, RISC-V... But let's not get ahead of ourselves, the platform will start with topics along the lines of how to code, javascript... The justification of this effort is to make a specialized place on the web for learning practical skills and concepts. The problem with google is that it is almost entirely guided by machines only, and for complex topics, it isn't enough.
⛳ Roadmap
- Finish basic functionalities of the website
- bugs in editing a page
- documentation for how first-adopters can contribute (not everyone can edit at first)
- provide a route for first-adopters to contribute (email?)
- self-publish pages (page builder that is specialized for tutorials -> video & text)
- polish the search functionality (tag system, neural network, or both/more)
- image upload module in the codebase (cdn)
- static pages
- about
- mission statement
- mobile version (css)
- Web Crawler
- only for the search page
- the concept now is just google but with mainly link wiki pages instead
- P2P/onion site
- allow the server to be distributed
- anyone can download the whole database
- along with the web crawler indexes
- figure out how to update features (CI: continuous integration?)
- Add a way for a voting system on feature changes (both what to work on / and what is accepted)
- And how to integrate with P2P/onion site
📘 Brief Documentation
Directory Structure
| directory | sub_dir | content |
|---|---|---|
| /.backstage/ | for coding references, sequential verbose messy codes | |
| /.topic/ | ./ | php html card modules files (seperated files that are included in topic.php create.php edit.php) |
| ./create/ | for create.php edit.php |
|
| ./modules/ | for topic.php |
|
| /AMA/ | temp static website for speedstor.net, sorry :) | |
| /api/ | temporary location for things that are supposed to be from a cdn | |
| /css/ | css files | |
| /feedbackPages/ | Basically, are error pages. Users are redirected to pages here if something unexpected happens | |
| /includes/ | Blocked pages. They are for logins, authentication, database manipulation, admin stuff... | |
| /js/ | javascript code | |
| /login/ | front end for logging in, log out, and stuff | |
| /requries/ | for communicating with database (might need to move) | |
| /secure/ | a more exclusive version of include. Error here can leak a lot of things and surrender control for the server | |
| /src/ | static images for website | |
| / | pages, main pages |
Current server setup
- docker
- mysql
- php
- adminer
- haproxy
- to share server with speedstor.net
- contact aldrin.cheung@gmail.com to get details
💚 Contribute Code
Any help on this project would be great appriciated :D. Because this project is currently so small, there are no rules. Just fork and submit a pull request