Elixir School's Extracurricular is a website and twitter bot intended to increase the visibility of open source opportunities within the community.

Once you have cloned the repo and cd'd in, its quite simple to get started. First, we get our dependencies and compile everything:

$ mix do deps.get, compile

Next we need to setup our database. Out-of-the-box Extracurricular uses Postgres with a user postgres and password postgres. If you're using anything different you'll need to fill out the proper credentials in apps/web/config/dev.exs and apps/web/config/test.exs.

To setup the database, migrate it, and populate it with dummy data we can use our handy alias:

$ mix ecto.setup

And the fun part, running the server! If you haven't done so already, this will compile your frontend dependencies:

$ iex -S mix phx.server

Visit localhost:4000 and you should see this a local instance of the application!

This is a project for the community, contributions are encouraged!

Feedback, feature requests, and fixes are welcomed. Please make appropriate use of Issues and Pull Requests. All code should have accompanying tests.

MIT license. Please see LICENSE for details.