From feb5eb0c274ff2def4b3129944e3e5f2efd677f6 Mon Sep 17 00:00:00 2001 From: nelsonic Date: Wed, 10 Jan 2024 16:03:13 +0000 Subject: [PATCH] update README.md #13 --- BUILDIT.md | 20 +++++++++++--------- README.md | 32 +++++++++++--------------------- lib/app/repository.ex | 3 +++ 3 files changed, 25 insertions(+), 30 deletions(-) diff --git a/BUILDIT.md b/BUILDIT.md index 759efc4..6019650 100644 --- a/BUILDIT.md +++ b/BUILDIT.md @@ -2,7 +2,7 @@ # Build Log 👩‍💻 -![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dwyl/who/Elixir%20CI?label=build&style=flat-square) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/who/ci.yml?label=build&style=flat-square&branch=main)](https://github.com/dwyl/who/actions/workflows/ci.yml) This is a log of the steps taken @@ -23,14 +23,16 @@ it in **10 minutes**. 🏁 > the other tutorials/examples, > but they are linked in case you get stuck. -In this log we have written the "CRUD" functions first -and _then_ built the UI.
+In this log we have written the +"[CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete)" +functions first +and _then_ built the interface.
We were able to do this because we had a good idea of which functions we were going to need.
If you are reading through this and scratching your head wondering where a particular function will be used, -simply scroll down to the UI section +simply scroll down to the interface section where (_hopefully_) it will all be clear. At the end of each step, @@ -55,7 +57,7 @@ With that in place, let's get building! - [1. Create a New `Phoenix` App](#1-create-a-new-phoenix-app) - [1.1 Run the `Phoenix` App](#11-run-the-phoenix-app) - [1.2 Run the tests:](#12-run-the-tests) - - [Test Coverage?](#test-coverage) + - [Test Coverage? ](#test-coverage-) - [1.3 Setup `Tailwind`](#13-setup-tailwind) - [1.4 Setup `LiveView`](#14-setup-liveview) - [1.5 Update `router.ex`](#15-update-routerex) @@ -172,14 +174,14 @@ Finished in 0.1 seconds (0.07s async, 0.07s sync) That tells us everything is working as expected. 🚀 -### Test Coverage? +### Test Coverage? [![codecov.io](https://img.shields.io/codecov/c/github/dwyl/who/main.svg?style=flat-square)](http://codecov.io/github/dwyl/who?branch=main) If you prefer to see **test coverage** - we certainly do - then you will need to add a few lines to the -[`mix.exs`](https://github.com/dwyl/app-mvp/blob/main/mix.exs) +[`mix.exs`](https://github.com/dwyl/who/blob/main/mix.exs) file and create a -[`coveralls.json`](https://github.com/dwyl/app-mvp/blob/main/coveralls.json) +[`coveralls.json`](https://github.com/dwyl/who/blob/main/coveralls.json) file to exclude `Phoenix` files from `excoveralls` checking. Add alias (shortcuts) in `mix.exs` `defp aliases do` list. @@ -203,7 +205,7 @@ mix c You should see output similar to the following: -Phoenix tests passing coverage 100% +Who tests passing coverage 100% ## 1.3 Setup `Tailwind` diff --git a/README.md b/README.md index ac1f266..805b7ff 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The **quick _answer_** to the question: **_Who_ is in the `@dwyl` community?** -![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/who/ci.yml?label=build&style=flat-square&branch=main) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/who/ci.yml?label=build&style=flat-square&branch=main)](https://github.com/dwyl/who/actions/workflows/ci.yml) [![codecov.io](https://img.shields.io/codecov/c/github/dwyl/who/main.svg?style=flat-square)](http://codecov.io/github/dwyl/who?branch=main) [![Hex.pm](https://img.shields.io/hexpm/v/elixir_auth_google?color=brightgreen&style=flat-square)](https://hex.pm/packages/elixir_auth_google) [![contributions welcome](https://img.shields.io/badge/feedback-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/app-who/issues) @@ -26,14 +26,14 @@ to the question: # *Why*? We needed an **easy/fast/reliable _system_** -to **_visualise_ who** is joining +to **_visualize_ who** is joining the **`@dwyl` community**
so that we can **track growth** over time. 📈 The [**start-here** > ***who***](https://github.com/dwyl/start-here/tree/8bbd28d2ab0c3b5a2a266a1e41fd160fc6ee3038#who) section ~~is~~ _was_ *woefully* out of date -because we had to update it _manually_. ⏳ +because we had to update it _manually_. ⏳
(_this was [noted](https://github.com/dwyl/start-here/issues/9) a while back... @@ -91,7 +91,7 @@ read: [**`BUILDIT.md`**](https://github.com/dwyl/who/blob/main/BUILDIT.md) -## Run the who App on your `localhost` ⬇️ +## Run the `Who` App on your `localhost` ⬇️ > **Note**: You will need to have **`Elixir`** and **`Postgres` installed**,
@@ -108,7 +108,7 @@ run the following commands in your terminal: ```sh -git clone git@github.com:dwyl/app-who.git && cd app-who +git clone git@github.com:dwyl/who.git && cd who mix setup ``` That will download the **`code`**, @@ -197,21 +197,11 @@ Please _share_: [**who/issues**](https://github.com/dwyl/who/issues) 🙏 ->-Alice: Hi Alice, I can hear you! - John-->>-Alice: I feel great! ++ List Repos in the Org: + https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-organization-repositories - - -```mermaid -sequenceDiagram - App->>+GitHub: GET @dwyl Organization members - GitHub-->>+App: Hi Alice, I can hear you! - App-->>-Alice: I feel great! -``` - ---> \ No newline at end of file ++ List of people that Star a given repo: + ++ \ No newline at end of file diff --git a/lib/app/repository.ex b/lib/app/repository.ex index 0c66f6c..81abe92 100644 --- a/lib/app/repository.ex +++ b/lib/app/repository.ex @@ -37,4 +37,7 @@ defmodule App.Repository do |> changeset(attrs) |> Repo.insert() end + + + end