Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaeyson/freecodecamp_elixir
Solving exercises from Freecodecamp.org using Elixir programming language. Includes benchmarks and tests for every functions.
https://github.com/jaeyson/freecodecamp_elixir
algorithm-scripting elixir elixir-lang elixir-programming-language exercises freecodecamp freecodecamp-elixir
Last synced: 10 days ago
JSON representation
Solving exercises from Freecodecamp.org using Elixir programming language. Includes benchmarks and tests for every functions.
- Host: GitHub
- URL: https://github.com/jaeyson/freecodecamp_elixir
- Owner: jaeyson
- License: mit
- Created: 2017-11-22T06:13:33.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T04:24:08.000Z (7 months ago)
- Last Synced: 2024-04-14T05:46:44.526Z (7 months ago)
- Topics: algorithm-scripting, elixir, elixir-lang, elixir-programming-language, exercises, freecodecamp, freecodecamp-elixir
- Language: Elixir
- Homepage: https://hexdocs.pm/freecodecamp_elixir
- Size: 228 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Freecodecamp exercises using Elixir
Solving exercises from Freecodecamp.org using Elixir programming language. Includes benchmarks and tests for every functions.
[//]: # "Badges"
[![Last Commit][commit-badge]](https://github.com/jaeyson/freecodecamp_elixir/commit/main)
[![Commit activity][pulse-badge]](https://github.com/jaeyson/freecodecamp_elixir/pulse)
[![Dependabot][dependabot-badge]](https://github.com/jaeyson/freecodecamp_elixir/pulls/app%2Fdependabot)
[![Actions Status][actions-badge]](https://github.com/jaeyson/freecodecamp_elixir/actions)
[![Coverage][coverage-badge]](https://coveralls.io/github/jaeyson/freecodecamp_elixir?branch=main)
[![Hex.pm][hex-badge]](https://hex.pm/packages/freecodecamp_elixir)
[![Hexdocs][hexdocs-badge]](https://hexdocs.pm/freecodecamp_elixir)
[//]: # "Image sources"
[commit-badge]: https://img.shields.io/github/last-commit/jaeyson/freecodecamp_elixir.svg
[pulse-badge]: https://img.shields.io/github/commit-activity/m/jaeyson/freecodecamp_elixir
[dependabot-badge]: https://img.shields.io/badge/Dependabot-enabled-green
[actions-badge]: https://github.com/jaeyson/freecodecamp_elixir/actions/workflows/ci.yml/badge.svg
[coverage-badge]: https://coveralls.io/repos/github/jaeyson/freecodecamp_elixir/badge.svg?branch=main
[hex-badge]: https://img.shields.io/hexpm/v/freecodecamp_elixir
[hexdocs-badge]: https://img.shields.io/badge/hex-docs-blue
Folders that are interesting to read can be found at:
- [`lib/`](https://github.com/jaeyson/freecodecamp_elixir/tree/main/lib/)
- [`test/`](https://github.com/jaeyson/freecodecamp_elixir/tree/main/test/)
## Elixir installation
Either use [Docker](https://docs.docker.com/get-docker/), this Docker automated install script `curl -sSL https://get.docker.com/ | sh`, or use [`asdf`](https://asdf-vm.com/#/core-manage-asdf).
## Using Docker
using `docker_start` shell script (use wsl on windows or git bash, otherwise this works both ?mac? and linux), or see the file if you want to use docker commands instead.
```bash
# I haven't tried this both on windows and mac, YMMV
source docker_start
```
Why `source docker_start` instead of `chmod +x ./docker_start`? read [run bash script doesn't work alias command](https://unix.stackexchange.com/a/386455/437416).
#### Getting dependencies
```bash
mix deps.get --only test
```
#### Launch REPL
```bash
iex -S mix
```
#### Stopping **Elixir** container, remove alias created by shell script
```bash
# where "elixir" is the name of the container
docker container stop elixir
# temporary alias are not persisted across different sessions
# but if you want to remove them
unalias elixir iex mix elixirc
```
## Create Pre-commit Hook
```bash
mix precommit
```
## Test
```bash
mix test
```
#### Coverage
```bash
mix text --cover
```
#### Selective tests
```bash
# i.e. you want to test only "Basic Algorithms"
mix selective_test basic_algo
# or more, separated by spaces
mix selective_test basic_algo intermediate_algo
# basic_algo = Basic Algorithm Scripting
# intermediate_algo = Intermediate Algorithm Scripting
```
## Generate `HTML` Docs
```bash
# running this generates docs in "doc/" directory
mix docs
```
## Benchmarks (using Benchee)
```bash
# view benchmark commands
mix help benchmark
```
```bash
# list available functions
mix benchmark --list
```
```bash
# specific function
mix benchmark mutation
```
```bash
# benchmark results saved as html in "benchmarks/" directory
mix benchmark mutation --html
```