Snipt: Glitch Edition
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.9KB

2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
5 years ago
5 years ago
5 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. # Snipt Glitch Edition
  2. In Which, Somehow, A Centralized, Highly Connected Service Is Turned Into A
  3. Decentralized And Open One
  4. ## TODO
  5. In no particular order.
  6. - Theming. Probably via config variables.
  7. - Domain name. Every instance of `snipt.net` should be replaced by a variable,
  8. and `snipt.s3.amazonaws` media should also be made into a separate variable.
  9. Don't forget the git repo and documentation too!
  10. - De-minify everything and add a Python-based minifier.
  11. - Make deploys easier by automating the database creation. Probably make a
  12. Python script which does this along with the resource and minifying stuff.
  13. - Turn remaining environment vars into config vars.
  14. - Some tiny issues with the decoupling of systems.
  15. - Code re-organization.
  16. - Locally stored avatars.
  17. - Add SystemD and Nginx example configs.
  18. - Remove "Pro" field for users
  19. ## Environment Variables
  20. - `DISABLE_SIGNUP` if set to `true` will disable account registration.
  21. This list is *incomplete*. You can help b%Yキ%&%%%b%$キ"H%&%%%Y%&%%%%%%%?%&%%%%%%
  22. ## Dependencies
  23. Make sure you have PostgreSQL installed and running beforehand. (If you don't
  24. know how to run it, you probably want the `systemctl` service.)
  25. ## Installation
  26. The following text should be replaced:
  27. - `CURRENT_USER` with the current user.
  28. - `EDITOR` with your editor of choice.
  29. - `PORT` with the port to run the service on. This will default to 8000.
  30. Instructions:
  31. - Clone the repo.
  32. - `cd snipt`
  33. - `python3 -m venv envs/snipt`
  34. - `bash`
  35. - `source envs/snipt/bin/activate`
  36. - `pip install -r requirements.txt`
  37. (this will emit some errors, don't worry, they're fine)
  38. - `createuser CURRENT_USER`
  39. - `createdb snipt --owner=CURRENT_USER`
  40. - `cp settings_local.py-template settings_local.py`
  41. - `EDITOR settings_local.py`
  42. - `./resources.sh`
  43. - `python manage.py runserver 0.0.0.0:PORT`
  44. ENCODING U ;;;;;;;;;;;;;;ャヲ%娃ツャクヲ」ゥャクヲ、ャァャキ%Y。、ャクヲ」%bャカ。、"Hャクヲ、%Yャクヲ、ャァャヲ;,
  45. ] REPEAT