Ace - Educational Webserver
Say hi, send me a message via twitter/gh-issue etc, they’re all good. I want to take a deep dive into TCP/HTTP and network protocols in general, so if your curious or on a similar voyage of discovery would be great to chat. Cheers.
Documentation for Ace is available on hexdoc
Installation
Available on Hex, the package can be installed as:
Add
ace
to your list of dependencies inmix.exs
:def deps do [{:ace, "~> 0.2.0"}] end ```
Usage
startup
From the console, start mix.
iex -S mix
In the iex
console, start a TCP server.
{:ok, server} = Ace.TCP.start(8080)
Connect
Use telnet to communicate with the echo server.
telnet localhost 8080
Wihin the telnet terminal
# once connected
WELCOME
hi
ECHO: hi
In the iex session
send(server, {:data, "BOO!"})
back in telnet terminal
BOO!
The plan
- To take this obviously deficient TCP echo server that I wrote as a beginner elixir developer and create a fully fledged HTTP server.
- Keep reasonable notes of progress so others can learn about how to build a web server in elixir.
- See what progress I have made in a year as an elixir developer.
Ace 0.1 (TCP echo)
The simplest TCP echo server that works. Checkout the source of version 0.1.0. The change log documents all enhancements to this prototype server.
Using Vagrant
Vagrant manages virtual machine provisioning.
Using Vagrant allows you to quickly get started with Ace
without needing to install Elixir/erlang on you machine.
If you do not know vagrant on you machine I would suggest just installing elixir on your host machine and ignoring the instructions here.
vagrant up
vagrant ssh
cd /vagrant
From this directory instructions will be that same as users running Elixir on their machine.
Contributing
Before opening a pull request, please open an issue first.
Once we’ve decided how to move forward with a pull request:
$ git clone git@github.com:CrowdHailer/Ace.git
$ cd Ace
$ mix deps.get
$ mix test
$ mix dialyzer.plt
$ mix dialyzer
Once you’ve made your additions, mix test
passes and mix dialyzer
reports no warnings, go ahead and open a PR!