Installation

THIS SECTION IS UNDER CONSTRUCTION.

If you have questions or would like to help please open an issue on GitHub.

This section explicitly explains the commands that are used to manage the installation of Augur locally.

---

make install

This command installs the project dependencies, sets up the default configuration file, and gathers database credentials.

Example:

$ make install

---

make install-dev

The same as make install, except it installs the additional developer dependencies and installs the packages in editable mode.

Example:

$ make install-dev

---

make clean

Removes logs, caches, and some other cruft that can get annoying. This command is used when things aren’t building properly or you think an old version of augur is getting in the way.

Example:

$ make clean

---

make rebuild

Used in conjunction with make clean to remove all build/compiled files and binaries and reinstall the project. Useful for upgrading in place.

Example:

$ make rebuild

---

make rebuild-dev

The same as make rebuild, except it installs the additional developer dependencies and installs the packages in editable mode.

Note

You can still use make clean as normal if something went wrong.

Example:

$ make rebuild-dev