Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmptrluke/foxtail
A Django-based project of many talents. And an OpenID Connect provider. The code behind furry.nz!
https://github.com/dmptrluke/foxtail
django foxtail python
Last synced: 19 days ago
JSON representation
A Django-based project of many talents. And an OpenID Connect provider. The code behind furry.nz!
- Host: GitHub
- URL: https://github.com/dmptrluke/foxtail
- Owner: dmptrluke
- License: mpl-2.0
- Created: 2019-09-09T07:57:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T06:18:20.000Z (10 months ago)
- Last Synced: 2024-03-21T08:40:19.541Z (10 months ago)
- Topics: django, foxtail, python
- Language: Python
- Homepage: https://furry.nz
- Size: 4.21 MB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 22
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# foxtail [](https://github.com/dmptrluke/foxtail/actions)
The code behind furry.nz - a login provider and general community website for the NZ furry community.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Requirements
The foxtail project requires at least **Python 3.6** and a recent-*ish* version of node.js.
We recommend you run all of the below commands in a dedicated [virtual environment](https://docs.python.org/3/library/venv.html)
to keep things tidy.
### Prerequisites
To get started, you'll need to install the Python requirements. You can do this with the following command.
```
pip install -r requirements.txt
```
And, the node.js requirements.
```
npm install
```
### Building Assets
When any files in the `assets` folder are updated, you'll need to re-build the assets. You will also need to
do this when you first install the project.
```
npm run-script build-dev
```
During development, you can also use `run-script watch` to enable live reloads.
### Configuration
A number of basic configuration options are required for foxtail to function. These can be
set using environment varibles, or placed in a `.env` file in the project root.
Included below is an example of a minimal `.env` file to be used for local development.
```
DEBUG=True
SITE_URL=http://127.0.0.1:8000
INTERNAL_IPS=127.0.0.1
# replace this with your own key!
SECRET_KEY=REPLACEME
```
To generate a new secret key, open a Python shell and run the following commands.
```py
from foxtail.utils import get_random_secret_key
get_random_secret_key()
```
### Installing
First, create the foxtail database.
```
./manage.py migrate
```
And then generate an RSA key.
```
./manage.py creatersakey
```
### Running
Now your development environment is ready, simply run the below to start it up.
```
./manage.py runserver
```
You should then be able to access foxtail at http://127.0.0.1:8000/.
## Running the tests
This project uses `pytest`, `pytest-django`, and `selenium` for automated code testing.
To install the dependencies for testing, use the following command. You may also need to follow
[additional steps](https://selenium-python.readthedocs.io/installation.html) to get the
selenium test suites to run.
```
pip install -r tests/requirements.txt
```
You can then use the following command to run the automated test suites.
```
pytest
```
## License
```
Copyright (c) Luke Rogers 2019-2021
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.
```
## Built With
* [Django](https://www.djangoproject.com/) - The backend, the star of the whole show.
* [Bootstrap](https://getbootstrap.com/) - Front-end CSS framework.
* [Webpack](https://webpack.js.org/) - Front-end bundling and asset management.
* [RQ (Redis Queue)](https://python-rq.org/) - Job queueing and background tasks.
## Thanks To
* [JetBrains](https://www.jetbrains.com/?from=furry.nz) - For providing software licenses for PyCharm Professional through their open source program.
* [BrowserStack](https://www.browserstack.com/open-source) - For providing free desktop and mobile web testing
through their open source program.