chore: Update README.md with basic usage instructions

This commit is contained in:
Robert Prehn 2021-02-20 12:20:47 -06:00
parent d48e2bc13a
commit 4dcce9214b

View file

@ -1,5 +1,23 @@
# Legendary
# Up and Running
In order to start the server, run `script/server`. Any dependencies required
will be installed automatically using [brew](https://brew.sh/),
[asdf](https://asdf-vm.com/#/), and [hex](https://hex.pm/).
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
# CI Configuration
Legendary comes with gitlab CI settings which should work for you with minimal
setup.
The CI script will automatically tag successful builds. To do this, you will
need to configure a [CI variable](-/settings/ci_cd) named `GITLAB_TOKEN`. This
token should be a [personal access token](/-/profile/personal_access_tokens) with
`read_repository, write_repository` permissions.
To start your Phoenix server:
* Install dependencies with `mix deps.get`
@ -7,11 +25,7 @@ To start your Phoenix server:
* Install Node.js dependencies with `npm install` inside the `assets` directory
* Start Phoenix endpoint with `mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
## Learn more
# Learn more
* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html