foxnouns/README.md
2024-04-18 16:46:35 +02:00

30 lines
1.2 KiB
Markdown

# pronouns.cc
pronouns.cc rewrite in Python, using Quart for routing, SQLAlchemy for the database, and Celery for background tasks.
## Running
This isn't anywhere *near* complete yet. For now, you can install [`poe`](https://github.com/nat-n/poethepoet),
run `poe migrate`, and then `poe server`.
For configuration, a `.env` file is used. See `foxnouns/settings.py`--all keys are required unless specified otherwise.
(Note that the docker-compose file doesn't work yet)
## License
This software is licensed under the GNU Affero General Public License, version 3 only.
Copyright (C) 2024 sam <u1f320>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.