⚠️ The methods described below for running Hub locally is for testing purposes only.
Prerequisite
Make sure you have a recent version of Docker and Docker Compose installed on your laptop, then type:
$ docker -v
Docker version 20.10.2, build 2291f61
$ docker compose version
Docker Compose version v2.32.4
⚠️ You may need to run the following commands withsudo, but this can be avoided by adding your user to the localdockergroup.
Project bootstrap
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap FLUSH_ARGS='--no-input'
This command builds the app-dev and frontend-dev containers, installs dependencies, performs database migrations and compiles translations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
Your Docker services should now be up and running 🎉
You can access the project by going to http://localhost:9800.
You will be prompted to log in. The default credentials are:
username: hub
password: hub
📝 Note that if you need to run them afterwards, you can use the eponymous Make rule:
$ make run
To do so, install the frontend dependencies with the following command:
$ make frontend-development-install
And run the frontend locally in development mode with the following command:
$ make run-frontend-development
To start all the services, except the frontend container, you can use the following command:
$ make run-backend
To execute frontend tests & linting only
$ make frontend-test
$ make frontend-lint
Adding content
You can create a basic demo site by running this command:
$ make demo
Finally, you can check all available Make rules using this command:
$ make help
Django admin
You can access the Django admin site at:
You first need to create a superuser account:
$ make superuser
When running the project, the following services are available:
| Service | URL / Port | Description | Credentials |
|---|---|---|---|
| Frontend | http://localhost:9800 | Main Hub frontend | hub@hub.world / hub |
| Backend API | http://localhost:9801 | Django | admin@admin.local / admin |
| Keycloak | http://localhost:9802 | Identity provider admin | admin / admin |
| Nginx | http://localhost:9803 | Nginx | No auth required |
| Mailcatcher | http://localhost:9804 | Email testing interface | No auth required |
| PostgreSQL | 9812 | Database server | user / pass |
| Redis | 9813 | Cache and message broker | No auth required |
| MinIO | 9805 and http://localhost:9806 | Local S3 storage | No auth required |
This work is released under the MIT License (see LICENSE).
While Hub is a public-driven initiative, our license choice is an invitation for private sector actors to use, sell and contribute to the project.
You can help us with translations on Crowdin.
If you intend to make pull requests, see CONTRIBUTING for guidelines.
docs
├── bin - executable scripts or binaries that are used for various tasks, such as setup scripts, utility scripts, or custom commands.
├── crowdin - for crowdin translations, a tool or service that helps manage translations for the project.
├── docker - Dockerfiles and related configuration files used to build Docker images for the project. These images can be used for development, testing, or production environments.
├── docs - documentation for the project, including user guides, API documentation, and other helpful resources.
├── env.d/development - environment-specific configuration files for the development environment. These files might include environment variables, configuration settings, or other setup files needed for development.
├── gitlint - configuration files for `gitlint`, a tool that enforces commit message guidelines to ensure consistency and quality in commit messages.
├── playground - experimental or temporary code, where developers can test new features or ideas without affecting the main codebase.
└── src - main source code directory, containing the core application code, libraries, and modules of the project.Hub is built on top of:
- Django Rest Framework
- Next.js
- and many other open source libraries and tools.
We thank the contributors of these projects for their awesome work!
