@@ 56,7 56,7 @@ You should also make sure you have all the tools required to initialize a standa
* The `direnv` command, to automatically configure environment variables when you enter your project's directory (https://direnv.net/docs/installation.html)
* It is also recommended to install the postgresql client package, to have access to the `psql` command
-Also, before running the `tulip-cli init` command, you should make sure you have [all the prerequisites required to install Tulip][#installation], otherwise it will fail to build some of its dependencies.
+Also, before running the `tulip-cli init` command, you should make sure you have [all the prerequisites required to install Tulip](#installation), otherwise it will fail to build some of its dependencies.
Then, assuming the binary directory of your LuaRocks tree is in your `$PATH`, you can initialize a tulip project by running:
@@ 68,15 68,15 @@ Where `DIR` is a directory path relative to the current working directory where
What the command does is:
* Create a project-local luarocks configuration, so that modules are installed locally in the `lua_modules` directory
-* Create the project-local directory for the postgresql database, as a docker image that includes the `pg_cron` extension
+* Create the project-local directory for the postgresql database, as a docker image that includes the [`pg_cron` extension][cron]
* Create the secrets for local development, such as the CSRF key, the account key and the root database user's password
-* Create the localhost certificates for https support
+* Create the localhost certificate for https support
* Create the `.envrc` direnv file with environment variables to connect to the database and to configure Lua search paths to use the local modules
* Install tulip
After running the command, you should manually:
* Approve the `.envrc` file by running `direnv allow .`
-* Bring the database up by running `docker-compose up --build`
+* Bring the database up by running `docker-compose up`
# Installation
@@ 87,7 87,7 @@ You must make sure you have the following prerequisites installed on your system
* The argon2 development files, required for the `argon2` dependency (Fedora: libargon2-devel)
* The zlib development files, required for the `lua-zlib` dependency (Fedora: zlib-devel)
-The preferred method is to use the `tulip-cli` command documented in [Getting Started][#getting-started], but you can also install tulip manually via LuaRocks:
+The preferred method is to use the `tulip-cli` command documented in [Getting Started](#getting-started), but you can also install tulip manually via LuaRocks:
```sh
luarocks install tulip
@@ 234,3 234,4 @@ To summarize, the app and packages "startup" lifecycle goes like this:
[http]: https://github.com/daurnimator/lua-http
[pg]: https://www.postgresql.org/
[blog]: https://mna.dev/posts/small-is-beautiful.html
+[cron]: https://github.com/citusdata/pg_cron