snipt/README.md

62 linhas
1.9 KiB
Markdown

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