Skip to content

Commit

Permalink
outline BUILDIT.md for #220
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonic committed Oct 14, 2022
1 parent d523971 commit b383ce0
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 139 deletions.
55 changes: 55 additions & 0 deletions BUILDIT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<div align="center">

# Build Log 👩‍💻
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dwyl/mvp/Elixir%20CI?label=build&style=flat-square)


This is a log
of the steps taken
to build the **`auth`** Application. 🚀 <br />
It took us _hours_
to write it,
but you can
[***speedrun***](https://en.wikipedia.org/wiki/Speedrun)
it in **20 minutes**. 🏁

</div>

# TODO: fill-in the gaps during the [Rebuild `#207`](https://github.com/dwyl/auth/issues/207)

For now I'm just adding the parts that are being added to the "old"
version of **`auth`** so that we can _easily_ re-create them in the re-build.

# ERD `before` adding `groups`

The database Entity Relationship Diagram (ERD)
had the following tables/relationships
before we added `groups`:




# 10. Groups

Our objective with **`groups`**
is to enable **`people`**
to invite others
to ***collaborate***
with them.

This is a _generalised_ version
that can be used in **_any_ application**
that requires collaboration/teamwork.

## 10.1 Create Schema

Run the folloiwng
[**`mix phx.gen.schema`**](https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Schema.html)
command to create the `groups` schema
as outlined in
[**`#220`**](https://github.com/dwyl/auth/issues/220)

```sh
mix phx.gen.schema Group groups name:binary description:binary
```

21 changes: 0 additions & 21 deletions ecto_erd.dot

This file was deleted.

116 changes: 0 additions & 116 deletions ecto_erd.mmd

This file was deleted.

7 changes: 5 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Auth.Mixfile do
def project do
[
app: :auth,
version: "1.6.6",
version: "1.6.7",
elixir: "~> 1.12",
elixirc_paths: elixirc_paths(Mix.env()),
compilers: [:phoenix, :gettext] ++ Mix.compilers(),
Expand Down Expand Up @@ -101,7 +101,10 @@ defmodule Auth.Mixfile do
{:ex_doc, "~> 0.28", only: :dev},
{:credo, "~> 1.4", only: [:dev], runtime: false},
{:dialyxir, "~> 1.0", only: [:dev], runtime: false},
{:sobelow, "~> 0.11.1", only: [:dev]}
{:sobelow, "~> 0.11.1", only: [:dev]},

# Create ERDs https://github.com/fuelen/ecto_erd
{:ecto_erd, "~> 0.5", only: :dev},
]
end

Expand Down
Loading

0 comments on commit b383ce0

Please sign in to comment.