summaryrefslogtreecommitdiff
path: root/web/source/panels/admin/README.md
diff options
context:
space:
mode:
authorLibravatar f0x52 <f0x@cthu.lu>2022-06-09 12:51:19 +0200
committerLibravatar GitHub <noreply@github.com>2022-06-09 12:51:19 +0200
commitb43f9ceca9f7e02248f1d88245ede5267e8b72c8 (patch)
tree1d6b64603e74c45785bf44dde194315344843e1e /web/source/panels/admin/README.md
parent[chore] gitignore shell.nix (#639) (diff)
downloadgotosocial-b43f9ceca9f7e02248f1d88245ede5267e8b72c8.tar.xz
[frontend] Restructure Frontend Sources (#634)
* 🐸restructure frontend stuff, include admin and future user panel in main repo, properly deduplicate bundles for css+js across uses * rename bundled to dist, caught by gitignore * re-include status.css for profile template * default to localhost * serve frontend panels * add todo message for abstraction * refactor oauth registration flow * oauth restructure * update footer template * change panel routes * remove superfluous css imports * write bundle to disk from test server, use forked budo-express * wrap all page content in container for robustness with addons etc injection other elements in body * update documentation, goreleaser, Dockerfile * update template meta tags * add AGPL-3.0+ license header everywhere * only attach update listener on EventEmitter * cleaner config for various frontend bundles * fix bundler script paths * Merge commit 'd191931932b9293ce1be44ed08a1e69b9fcc1e25' * fix up dockerfile, goreleaser * go mod tidy * add uglifyify * move status hide/show js to frontend bundle * fix stylesheet color( func regressions * update contributing docs for new build path * update goreleaser + docker building * resolve dependency paths properly * update package name * use api errorhandler Co-authored-by: tsmethurst <tobi.smethurst@protonmail.com>
Diffstat (limited to 'web/source/panels/admin/README.md')
-rw-r--r--web/source/panels/admin/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/web/source/panels/admin/README.md b/web/source/panels/admin/README.md
new file mode 100644
index 000000000..9a4572270
--- /dev/null
+++ b/web/source/panels/admin/README.md
@@ -0,0 +1,21 @@
+# GoToSocial Admin Panel
+
+Standalone web admin panel for [GoToSocial](https://github.com/superseriousbusiness/gotosocial).
+
+A public hosted instance is also available at https://gts.superseriousbusiness.org/admin/, so you can fill your own instance URL in there.
+
+## Installation
+Build requirements: some version of Node.js with npm,
+```
+git clone https://github.com/superseriousbusiness/gotosocial-admin.git && cd gotosocial-admin
+npm install
+node index.js
+```
+All processed build output will now be in `public/`, which you can copy over to a folder in your GoToSocial installation like `web/assets/admin`, or serve elsewhere.
+No further configuration is required, authentication happens through normal OAUTH flow.
+
+## Development
+Follow the installation steps, but run `NODE_ENV=development node index.js` to start the livereloading dev server instead.
+
+## License, donations
+[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html). If you want to support my work, you can: <a href="https://liberapay.com/f0x/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a> \ No newline at end of file