diff --git a/.gitignore b/.gitignore index fdd13a6e..d01e313a 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,6 @@ npm-debug.log # for vscode elixir_ls extension files /.elixir_ls + +# dev +TODO.md diff --git a/README.md b/README.md index fa1aab6f..e825e73c 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,7 @@ # Shift73k -See full article [here](https://www.leanpanda.com/blog/authentication-and-authorisation-in-phoenix-liveview/). +Calendaring app for shift-worker shift tracking, with support for CSV export and sharing work schedule with others. -## Start server +## Tech -To start your Phoenix server: - - * Install dependencies with `mix deps.get` - * Create and migrate your database with `mix ecto.setup` - * 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 - - * 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 +Written in Elixir & Phoenix LiveView.