luckyframework / luckyframework/website

Docs for customizing starting a dev server

Open
#1,383 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Crystal
Stars
39
Forks
62
PR merge metrics
No merged PRs in 30d

Description

This section should mention show to use the `DEV_PORT` env and also how the `config/watch.yml` works.
https://luckyframework.org/guides/getting-started/starting-project#start-the-server

To change your port or host, you update your `config/watch.yml`, but if you use `overmind` or other such process runners, these use `PORT` which causes your `config/watch.yml` to be ignored, so you need to use `DEV_PORT` or `DEV_HOST` env. However, because the `.env` file isn't read until runtime, you need the `DEV_PORT` and `DEV_HOST` values to exist before compile time which means they need to be specified in the CLI (e.g. `DEV_PORT=3004 lucky dev`)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Start the server” section at the linked getting-started guide and review how config/watch.yml is described. Document DEV_PORT and DEV_HOST, including their interaction with PORT-based process runners and the need to provide values on the lucky dev command line before compilation. Done means the guide explains both configuration paths and their precedence.

Written by the indexing model from the issue text.

Assessment

Tech stack
crystal
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.