Populate README with meaningful content
This commit is contained in:
parent
8450d24ad9
commit
ce58708876
1 changed files with 22 additions and 4 deletions
26
README.md
26
README.md
|
@ -1,16 +1,34 @@
|
||||||
# RecycledCloud
|
# Recycled Cloud Management Interface
|
||||||
|
|
||||||
To start your Phoenix server:
|
This repository tracks the initial work for a web interface atop the recycled
|
||||||
|
cloud. It is written in [Elixir](https://elixir-lang.org/), making use of the
|
||||||
|
[Phoenix Web Framework](https://www.phoenixframework.org/).
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
* The (Phoenix) project has been initialized with the `--no-webpack` and
|
||||||
|
`--no-dashboard` flags to avoid unnecessary clutter. We can add them back
|
||||||
|
later if needed!
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
You'll need Erlang/OTP and elixir installed on your system. It usually boils
|
||||||
|
down to installing the `elixir` package of your distribution. Once done, you
|
||||||
|
can:
|
||||||
|
|
||||||
* Install dependencies with `mix deps.get`
|
* Install dependencies with `mix deps.get`
|
||||||
* Create and migrate your database with `mix ecto.setup`
|
* Create and migrate your database with `mix ecto.setup`
|
||||||
|
- You'll need PostgreSQL here. I (tfloure) usually run it in an isolated
|
||||||
|
container with something along the lines of `podman run --rm -it -e
|
||||||
|
POSTGRES_HOST_AUTH_METHOD=trust --expose 5432 -p 5432:5432
|
||||||
|
postgres:latest`.
|
||||||
* Start Phoenix endpoint with `mix phx.server`
|
* Start Phoenix endpoint with `mix phx.server`
|
||||||
|
|
||||||
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
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).
|
## Useful Resources
|
||||||
|
|
||||||
## Learn more
|
Phoenix Web Framework:
|
||||||
|
|
||||||
* Official website: https://www.phoenixframework.org/
|
* Official website: https://www.phoenixframework.org/
|
||||||
* Guides: https://hexdocs.pm/phoenix/overview.html
|
* Guides: https://hexdocs.pm/phoenix/overview.html
|
||||||
|
|
Loading…
Reference in a new issue