Extracurricular

We've decided to put Extracurricular on hold because interest just wasn't there. We may come back to it in the future once we've had a time to rethink our approach.

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

Running the Project

Once you have cloned the repo and cd'd in, it's 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

Install node packages and build brunch assets:

$ cd apps/web/assets && npm install && node node_modules/brunch/bin/brunch build && cd ../../../

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!

Getting Involved

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.

License

MIT license. Please see LICENSE for details.