add README
This commit is contained in:
parent
9f2e4c5d21
commit
e1afacc4e6
1 changed files with 6 additions and 14 deletions
20
README.md
20
README.md
|
@ -1,18 +1,10 @@
|
||||||
# Groupdle
|
# Groupdle
|
||||||
|
|
||||||
To start your Phoenix server:
|
A competitive Wordle-inspired online party game
|
||||||
|
|
||||||
* Run `mix setup` to install and setup dependencies
|
## Setup
|
||||||
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
|
|
||||||
|
|
||||||
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
1. Install [mise](https://mise.jdx.dev/)
|
||||||
|
2. Install tools: `mise install`
|
||||||
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
|
3. Install dependencies: `mix deps.get`
|
||||||
|
4. Start development server: `iex -S mix phx.server`
|
||||||
## Learn more
|
|
||||||
|
|
||||||
* Official website: https://www.phoenixframework.org/
|
|
||||||
* Guides: https://hexdocs.pm/phoenix/overview.html
|
|
||||||
* Docs: https://hexdocs.pm/phoenix
|
|
||||||
* Forum: https://elixirforum.com/c/phoenix-forum
|
|
||||||
* Source: https://github.com/phoenixframework/phoenix
|
|
||||||
|
|
Loading…
Reference in a new issue