paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 16:43:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7bf16f4bc971954d54e1126759b15475dd4d0f44
zulip/docs/development/using.md
David Rosa Tamsen 7072fa5b37 docs: Reorganize developer docs to improve navigation. 
This commit helps reduce clutter on the navigation sidebar.
Creates new directories and moves relevant files into them.
Modifies index.rst, symlinks, and image paths accordingly.

This commit also enables expandable/collapsible navigation items,
renames files in docs/development and docs/production,
modifies /tools/test-documentation so that it overrides a theme setting,
Also updates links to other docs, file paths in the codebase that point
to developer documents, and files that should be excluded from lint tests.

Note that this commit does not update direct links to
zulip.readthedocs.io in the codebase; those will be resolved in an
upcoming follow-up commit (it'll be easier to verify all the links
once this is merged and ReadTheDocs is updated).

Fixes #5265.
2017-11-16 09:45:08 -08:00

2.6 KiB
Raw Blame History

Using the Development Environment

Once the development environment is running, you can visit http://localhost:9991/ in your browser. By default, the development server homepage just shows a list of the users that exist on the server and you can login as any of them by just clicking on a user. This setup saves time for the common case where you want to test something other than the login process; to test the login process you'll want to change AUTHENTICATION_BACKENDS in the not-PRODUCTION case of zproject/settings.py from zproject.backends.DevAuthBackend to use the auth method(s) you'd like to test.

While developing, it's helpful to watch the run-dev.py console output, which will show any errors your Zulip development server encounters.

To manually query the Postgres database, run psql zulip for an interactive console.

When you make a change, here's a guide for what you need to do in order to see your change take effect in Development:

  • If you change JavaScript, CSS, or Jinja2 backend templates (under templates/), you'll just need to reload the browser window to see changes take effect. The Handlebars frontend HTML templates (static/templates) are automatically recompiled by the tools/compile-handlebars-templates job, which runs as part of tools/run-dev.py.

  • If you change Python code used by the main Django/Tornado server processes, these services are run on top of Django's manage.py runserver which will automatically restart the Zulip Django and Tornado servers whenever you save changes to Python code. You can watch this happen in the run-dev.py console to make sure the backend has reloaded.

  • The Python queue workers will also automatically restart when you save changes. However, you may need to ctrl-C and then restart run-dev.py manually if a queue worker has crashed.

  • If you change the database schema, you'll need to use the standard Django migrations process to create and then run your migrations; see the new feature tutorial for an example. Additionally you should check out the detailed testing docs for how to run the tests properly after doing a migration.

(In production, everything runs under supervisord and thus will restart if it crashes, and upgrade-zulip will take care of running migrations and then cleanly restaring the server for you).