Added LICENSE and enhanced project documentation

Introduced an MIT LICENSE file for open sourcing the project, ensuring
that users are aware of their rights to use, modify, and distribute the
software. This change underlines our commitment to the open source
community and clarifies usage terms.

Updated the README.md with detailed development setup instructions,
making it easier for new contributors to get started with the project.
The amendments include steps from cloning the repository to starting the
development server, highlighting mandatory installations and
configurations for a smooth setup.

Adjusted settings.py and settings.dist.ini for better clarity and
customization. Simplifications in settings.py improve code readability
and maintainability. The addition of settings.dist.ini allows users to
easily configure their development and production environments per their
needs without altering core configuration files.

These enhancements aim to simplify the contribution process, foster
community involvement, and ensure a transparent and flexible setup for
developers engaging with the project.

2024-03-14 18:14:25 +01:00

3.1 KiB

Raw Blame History

Quackscape - A panoramic content management system for the web.

Quackscape is a content management system for panoramic/VR photos and videos. It is designed to be a simple and easy to use platform for sharing panoramic content on the web. It is built using the Django web framework and is designed to be easily deployable on a variety of platforms.

Requirements

Python 3.8+
Redis
NodeJS / NPM
ffmpeg (for video processing)
MariaDB or MySQL (optional but recommended)
A web server (Caddy, gunicorn, Nginx, Apache, etc.) (optional but recommended)

Development Setup

Clone the repository
Create a virtual environment and install the requirements

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Install the frontend dependencies

npm install

Copy settings.dist.ini to settings.ini and fill in the required settings
Run the migrations

python manage.py migrate

Compile the frontend assets

npm run build:dev

If you are working on the frontend, you can instead use the npm run watch:dev command to automatically recompile the frontend assets when they change.

Run the development server

python manage.py rundev

Create a superuser

python manage.py createsuperuser

Visit http://localhost:8000 in your web browser

Production Setup

As this is still quite a ways from a stable project, we do not include production setup steps here. Very fundamentally, the production setup would be similar to the development setup. However, there are a few differences:

Instead of npm run build:dev, you should run npm run build.
You should make sure to configure a database such as MariaDB or MySQL. You should not use the default SQLite database in production.
Instead of python manage.py runserver, you should use a production-ready web server such as Caddy and gunicorn.
Instead of python manage.py runserver, you will want to use the python manage.py runworker command to start the background worker process.
You may want to use systemd or another process manager to keep the server and worker processes running in the background.

Workers

Quackscape uses a background worker to process uploaded photos and videos. You can start the worker process using the python manage.py runworker command.

You may want to run the worker process on another machine. The server part is not very resource-hungry, so it can easily run on a VPS, but for video processing, you may want to use a machine with more resources, ideally with a powerful GPU.

To run the worker process on another machine, you first follow the basic setup instructions on that machine as well, then add a line like this to the worker's settings.ini:

[Quackscape]
Redis = redis://<redis-ip>:6379/0

Replace <redis-ip> with the IP address of the machine running the Redis server. This way, the worker will be able to fetch tasks from the same Redis server the Quackscape server is writing them to.

License

This project is licensed under the MIT License - see the LICENSE file for details.

3.1 KiB Raw Blame History