LauraBeatris/elixir-diary

create and list diary notes by using a mix task

โ˜… 1Forks 0ElixirGitHub โ†—Compare

README

Elixir Diary

Create and list notes of your diary

Author Languages Stars Forks Contributors


Check out the docs


๐Ÿ“Œ Table of Contents

๐Ÿ‘ท Installation

Make sure you have Elixir installed. If you're on a Mac, just run brew install elixir

Run mix deps.get to install the dependencies defined inside mix.exs

๐Ÿ“Œ Usage

Run mix diary

$ mix diary
Welcome to your diary! ๐Ÿ“–
Today is August 16, 2020
{...}

๐Ÿ—๏ธ Development

  • Start mix test.watch and develop TDD or run tests only once with mix test
  • To give the code a try in the REPL use iex -S mix and try the this:
Diary.create_note("Testing")
  • Format code using mix format
  • Lint code using mix credo and mix dialyzer

๐Ÿ› Issues

Feel free to file a new issue with a respective title and description on the the Elixir Diary repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

๐ŸŽ‰ Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

๐Ÿ“• License

Released in 2020

This project is under the MIT license.

Made with love by Laura Beatris ๐Ÿ’œ๐Ÿš€

Contributors

LauraBeatris

Issues