Neospring is a simple Q&A social network designed for community! On Neospring, users can create and customize their profile to look how they want, and then other users can ask them questions using their account or an anonymous username. Users receive questions in their inbox and can then answer them or manage them. Users can also ask “global questions” which everybody who is following them can see in a specialized timeline. Global questions can be answered by any logged-in user. Users can also respond to existing responses with comments to further interact with their friends' responses!
To start, clone the Neospring repository and build it:
git clone --recurse-submodules https://github.com/swmff/neospring
cd neospring
just build sqliteInstead of “sqlite”, you can also use “mysql" or "postgres” for MySQL/MariaDB and PostgreSQL respectively!
Neospring requires hCaptcha to secure logins and registers. You can provide your h-captcha configuration in ~/.config/xsu-apps/neospring/config.toml:
# ...
[captcha]
site_key = "..."
secret = "..."You can sign up for an hCaptcha account at https://www.hcaptcha.com/!
For Neospring to properly serve static assets, you must link the static directory to ~/.config/xsu-apps/neospring/static:
ln -s /path/to/neospring/static ~/.config/xsu-apps/neospring/staticYou can provide a Markdown file for /site/about by creating static/site/about.md. This file can be used to provide information about your specific instance!
After you have created your first account, you'll need to manually create a permissions group in the database so that you can mark the account as a Manager. The manager permission allows you to delete accounts, responses, comments, and questions. You can also view profile warnings and reports with this permission. You can view an example SQL query to do this here!
You can add additional moderators with the Helper role. They can also be given Manager, however Helper is much better if you want them to have limited moderation abilities.
To open your instance up for free account registration, you'll need to set registration_enabled to true in ~/.config/xsu-apps/neospring/config.toml.
You are responsible for adding your own manifest.json file in the static/ directory.
You can place your PWA logo images in static/images/logo/. This directory is ignored by git.
You can view information about contributing to Neospring here, as well as the contributor code of conduct here!
You can view security information here.
Neospring is a faithful recreation of the amazing Q&A site Retrospring. Neospring uses many Retrospring's core concepts, ideas, and designs, however it is built from the ground up and uses none of Retrospring's original code or assets.
Neospring uses Twemoji on its HTML pages for uniform emojis.