mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
b79b068568
The astro dev server takes a lot of memory and is disabled by default in `run-dev`. We add another option to only run the dev server which is the recommended mode for development. We still keep around the `--help-center-dev-server` mode for folks who have machines with higher specifications. See https://chat.zulip.org/#narrow/channel/19-documentation/topic/edits.20not.20appearing.20with.20vagrant/near/2256856
177 lines
8.9 KiB
HTML
177 lines
8.9 KiB
HTML
{% extends "zerver/portico.html" %}
|
|
|
|
{% block title %}
|
|
<title>Tools and data sets | Zulip Dev</title>
|
|
{% endblock %}
|
|
|
|
{# Login page. #}
|
|
{% block portico_content %}
|
|
|
|
<div class="app flex full-page">
|
|
<div id="devtools-page" class="markdown">
|
|
<h1>Useful development URLs</h1>
|
|
<p>
|
|
Below is a list of useful tools and data sets available only in the Zulip
|
|
development environment that are often useful when contributing to Zulip.
|
|
Most of these require you to run a command to build/generate the relevant
|
|
content. This table specifies which command to use to update the data served
|
|
by each page (since several of these, like test coverage, require a special
|
|
command to be run to generate the data). Make sure your development server is still running
|
|
when you visit these!
|
|
</p>
|
|
<table class="table table-striped table-rounded table-bordered">
|
|
<thead>
|
|
<tr>
|
|
<th>URL</th>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a href="/coverage/index.html">/coverage/index.html</a></td>
|
|
<td><code>./tools/test-backend --coverage</code></td>
|
|
<td>Backend (Django) test coverage report</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/node-coverage/index.html">/node-coverage/index.html</a></td>
|
|
<td><code>./tools/test-js-with-node --coverage</code></td>
|
|
<td>Frontend (node) test coverage report</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/index.html">/docs/index.html</a></td>
|
|
<td><code>./tools/build-docs</code></td>
|
|
<td>Developer documentation (ReadTheDocs) built locally</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/emails">/emails</a></td>
|
|
<td>View outgoing and example emails.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/stats/realm/analytics/">/stats/realm/analytics/</a></td>
|
|
<td><code>./manage.py populate_analytics_db</code><br />
|
|
Run the command after changing analytics data population logic.
|
|
</td>
|
|
<td>View the /stats page with some pre-populated data</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/webpack/5xx.html">/webpack/5xx.html</a></td>
|
|
<td>None needed</td>
|
|
<td>Error 5xx page served by nginx (used when Django is totally broken)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/errors/404">/errors/404</a></td>
|
|
<td>None needed</td>
|
|
<td>Error 404 page served by Django</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/errors/5xx">/errors/5xx</a></td>
|
|
<td>None needed</td>
|
|
<td>Error 5xx page served by Django</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/accounts/do_confirm/invalid">/accounts/do_confirm/invalid</a></td>
|
|
<td>None needed</td>
|
|
<td>Invalid confirmation link page</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/devtools/integrations">/devtools/integrations</a></td>
|
|
<td>None needed</td>
|
|
<td>Test incoming webhook integrations</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/devtools/buttons">/devtools/buttons</a></td>
|
|
<td>None needed</td>
|
|
<td>Test button styles</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/devtools/banners">/devtools/banners</a></td>
|
|
<td>None needed</td>
|
|
<td>Test banner styles</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/devtools/inputs">/devtools/inputs</a></td>
|
|
<td>None needed</td>
|
|
<td>Test input styles</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2>Useful management commands</h2>
|
|
<p>Development-specific <a href="https://zulip.readthedocs.io/en/latest/production/management-commands.html">management commands</a> live in <code>zilencer/management/commands</code>. Highlights include:</p>
|
|
<ul>
|
|
<li><code>./manage.py populate_db</code>: Rebuilds database. Has options to, for example, create 3K users for testing.</li>
|
|
<li><code>./manage.py mark_all_messages_unread</code>: Useful for testing reading messages.</li>
|
|
<li><code>./manage.py create_realm</code>: Add a new realm. Useful for testing onboarding.</li>
|
|
<li><code>./manage.py create_user</code>: Add a new user. Useful for testing onboarding.</li>
|
|
<li><code>./manage.py send_zulip_update_announcements</code>: Send <a href="https://zulip.com/help/configure-automated-notices#zulip-update-announcements">Zulip
|
|
update notices</a> drafted in `zerver/lib/zulip_update_announcements.py`.</li>
|
|
<li><code>./manage.py add_mock_conversation</code>: Add test messages, streams, images, emoji, etc.
|
|
into the dev environment. First edit zilencer/management/commands/add_mock_conversation.py
|
|
to add the data you're testing.
|
|
</li>
|
|
</ul>
|
|
<p>We also have
|
|
<a href="https://zulip.readthedocs.io/en/latest/development/authentication.html">documentation on testing LDAP, Google & GitHub authentication</a> in the development environment.
|
|
</p>
|
|
<h2>Connecting to the local PostgreSQL database</h2>
|
|
<ul>
|
|
<li>
|
|
<code>./manage.py dbshell</code>: Connect to
|
|
PostgreSQL database via your terminal.
|
|
</li>
|
|
<li>
|
|
<code>provision</code> creates a <code>~/.pgpass</code> file,
|
|
so <code>psql -U zulip -h localhost</code> works too.
|
|
</li>
|
|
<li>
|
|
<p>
|
|
To connect using a graphical PostgreSQL client
|
|
like <a href="https://www.pgadmin.org/">pgAdmin</a>,
|
|
use the following credentials:
|
|
</p>
|
|
<ul>
|
|
<li>Host: 127.0.0.1 (don't use localhost)</li>
|
|
<li>Maintenance database: zulip</li>
|
|
<li>Username: zulip</li>
|
|
<li>password: stored as <code>local_database_password</code> in <code>zulip/zproject/dev-secrets.conf</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2>Development instructions for help center</h2>
|
|
<p>
|
|
Running <code>./tools/run-dev</code> without any flags will not run the help center at all.
|
|
The development server for the help center takes significant resources to run and we don't
|
|
want to increase the minimum requirements to run Zulip for development.
|
|
</p>
|
|
<h3> Dev server (supports hot reload but not search)</h3>
|
|
<p>
|
|
This mode is useful when you are editing a help center file, and want to visualize the changes
|
|
quickly in the help center documentation.
|
|
</p>
|
|
<p>
|
|
<code>./tools/run-dev --only-help-center</code> will run a dev server at
|
|
<code>/help</code> that supports hot reload. Note that, with this flag, search will not work
|
|
in the help center docs. In this mode, the Zulip web app and other related services will not run.
|
|
Since the dev server consumes a significant amount of memory, this is the recommended way to run
|
|
the dev server for the help center.
|
|
</p>
|
|
<p>
|
|
If you have a machine with resources significantly more than minimum requirements to run Zulip in
|
|
development, you can choose to run the dev server alongside Zulip using
|
|
<code>./tools/run-dev --help-center-dev-server</code>.
|
|
The dev server makes a bunch of request to base Zulip URL instead of scoping it to the astro/starlight
|
|
base url. For this reason, in this mode, we run the dev server on it's own port and redirect help center
|
|
requests to the appropriate port (9995 by default).
|
|
</p>
|
|
<h3> Serve static build (supports search but not hot reload)</h3>
|
|
<p>
|
|
Please run <code>./tools/build-help-center</code> to generate a static build of the help center.
|
|
<code>./tools/run-dev --help-center</code> will host the generated build on
|
|
<code>/help</code>. Note that you need to generate a build and pass the flag mentioned for the search
|
|
to work.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
{% endblock %}
|