{"id":18184261,"url":"https://github.com/muzhawir/learn_elixir_from_documentation","last_synced_at":"2025-04-07T12:17:23.058Z","repository":{"id":260640229,"uuid":"878997647","full_name":"muzhawir/learn_elixir_from_documentation","owner":"muzhawir","description":"Learn Elixir through the official documentation","archived":false,"fork":false,"pushed_at":"2024-12-03T15:47:16.000Z","size":48,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-19T23:41:07.160Z","etag":null,"topics":["elixir","learn-project"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/muzhawir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-26T17:19:34.000Z","updated_at":"2024-12-06T12:11:08.000Z","dependencies_parsed_at":"2024-11-01T15:19:06.905Z","dependency_job_id":"eb70c575-a650-4905-853d-50c6299b2916","html_url":"https://github.com/muzhawir/learn_elixir_from_documentation","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"69d31ecdd2f1cd3393e91aeb8d0c0418b31a8225"},"previous_names":["muzhawir/learn_elixir_from_documentation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muzhawir%2Flearn_elixir_from_documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muzhawir%2Flearn_elixir_from_documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muzhawir%2Flearn_elixir_from_documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muzhawir%2Flearn_elixir_from_documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muzhawir","download_url":"https://codeload.github.com/muzhawir/learn_elixir_from_documentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238677009,"owners_count":19511925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","learn-project"],"created_at":"2024-11-02T21:03:48.280Z","updated_at":"2025-02-13T14:49:44.748Z","avatar_url":"https://github.com/muzhawir.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Learn Elixir from the Official Documentation\n\n[![Elixir CI](https://github.com/muzhawir/learn_elixir_from_documentation/actions/workflows/elixir.yml/badge.svg)](https://github.com/muzhawir/learn_elixir_from_documentation/actions/workflows/elixir.yml)\n\nThis repository shows my journey learning Elixir by following the\n[official documentation](https://hexdocs.pm/elixir/introduction.html), especially the\n\"Getting Started\" section. Instead of using IEx or [livebook.dev](https://livebook.dev),\nI decided to go right into a Mix project. This lets me get used to the real workflow of an Elixir\nproject and start coding right away.\n\nFor each chapter, I make a module to follow the examples in the documentation and then recreate\nthem using my own functions, keeping them close to the original examples. This practice helps me\nget familiar with writing production-quality code. I’m also learning to add `@moduledoc`, `@doc`,\nand `@spec` comments and practice TDD with `ExUnit`. My goal is to understand Elixir basics well\nbefore moving on to learning Phoenix.\n\n## Other Learning References\n\nI also use the book [Elixir in Action](https://www.manning.com/books/elixir-in-action-third-edition)\n, which is a recommended resource for learning Elixir. I purchased the 3rd edition, which is based\non Elixir version 1.15.\n\n## Installation\n\nInstall Erlang and Elixir. This project uses `Erlang v27.1.1` and `Elixir v1.17.3`. To manage\nmultiple versions of Erlang and Elixir, try the\n[vfox version manager](https://github.com/version-fox/vfox).\n\nClone this project to your local machine:\n\n```bash\n# Using HTTPS\ngit clone https://github.com/muzhawir/learn_elixir_from_documentation.git\n\n# Using GitHub CLI\ngh repo clone muzhawir/learn_elixir_from_documentation\n```\n\nThen go to the project directory and install dependencies:\n\n```bash\ncd learn_elixir_from_documentation\nmix deps.get\n```\n\n## Packages\n\nThis repository uses these packages:\n\n- [credo](https://github.com/rrrene/credo): A static analysis tool that helps write better Elixir\ncode by pointing out common mistakes and inconsistencies. It’s a great tool for beginners who want\nto learn to code well in Elixir.\n- [styler](https://github.com/adobe/elixir-styler): A formatting tool for Elixir. Styler combines\nthe functions of `mix format` and `mix credo` to fix code style automatically. I use both Credo\nand Styler to see how they work together, though for beginners, I recommend starting with Credo.\n- [dialyxir](https://github.com/jeremyjh/dialyxir): Since each function has `@spec`, I use Dialyxir\nto check type specifications with Dialyzer. Dialyzer finds issues like type errors, unreachable\ncode, and unnecessary tests. Dialyxir makes Dialyzer easier to use in Elixir projects.\n\n## Todo List\n\n- [x] [Basic Types](./lib/basic_types.ex)\n- [x] [Lists and Tuples](./lib/list_and_tuples.ex)\n- [x] [Pattern Matching](./lib/pattern_matching.ex)\n- [x] [`case`, `cond`, and `if`](./lib/case_cond_if.ex)\n- [x] [Anonymous Functions](./lib/anonymous_function.ex)\n- [x] [Binaries, Strings, and Charlists](./lib/binaries_strings_and_charlists.ex)\n- [x] [Keyword Lists and Maps](./lib/keyword_lists_and_maps.ex)\n- [x] [Modules and Functions](./lib/modules_and_functions.ex)\n- [x] [Recursion](./lib/recursion.ex)\n- [x] [Enumerables and Streams](./lib/enumerables_and_streams.ex)\n- [ ] Processes\n- [ ] IO and the File System\n- [ ] `alias`, `require`, `import`, and `use`\n- [ ] Module Attributes\n- [ ] Structs\n- [ ] Protocols\n- [ ] Comprehensions\n- [ ] Sigils\n- [ ] `try`, `catch`, and `rescue`\n- [ ] Writing Documentation\n- [ ] Optional Syntax Sheet\n- [ ] Erlang Libraries\n- [ ] Debugging\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuzhawir%2Flearn_elixir_from_documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuzhawir%2Flearn_elixir_from_documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuzhawir%2Flearn_elixir_from_documentation/lists"}