Anacounts

Share expenses, make it fair

Anacounts is a free and open-source application meant to easen the burden of sharing expenses. It allows to split the bill via different means, to make it more fair.

Hosting

There is no single instance of the application, you are encouraged to deploy your own. The operation should fairly straightforward: build the Docker image, push to it your favorite registry, and run it.

Contributing

All contributions are welcome, whether code, reviews, testing or anything really! The project is too young to have a code of conduct or contributing guidelines. Just know that I can be pretty picky on reviews - you've been warned 😄

Getting started

Tools

The project runs on Elixir/Phoenix, and a little NodeJS for packaging. You should consider installing the required tools through asdf. Once asdf is ready, run asdf install whilst in the project, and let it install everything you need to run the project.

$ asdf install

Dependencies

Once the Elixir language, Erlang VM, and NodeJS are installed, you will need to fetch the dependencies of the project. There are no NodeJS dependencies (so long node_modules), so all you have to do is run mix deps.get. If you haven't installed it already, this command will prompt you to install "Hex" (and maybe "rebar3"), which you should do.

$ mix deps.get

The dependencies were fetched and will be compiled when starting the project for the first time. That's almost it! The last thing we need is a database - could become handy right?

Database

The app uses PostgreSQL as dbms. For local development, I personally favour using a Docker container over actually installing PostgreSQL on my machine - it's easier to get rid of.

Here is the minimal command you can use to create a Postgres container.

$ docker run \
    --name anacounts-postgres \
    --env POSTGRES_PASSWORD=postgres \
    --publish 5432:5432 \
    --detach \
    postgres

If you don't use Docker to create your database, know that all you need for dev and test environments is a database hosted on localhost, which username and password is "postgres". The database will automatically be created later by Ecto - the library handling the database.

Once the database is up-and-running, we can actually create the Postgres databases. To do that, run the command mix ecto.setup from the apps/app directory. This will create an "anacounts_dev" database and run the migrations.

$ cd apps/app
$ mix ecto.setup

Run the app

The development environment is ready for Anacounts to start! Go back to the root directory, and launch the application with mix phx.server. You can now go to http://localhost:4000 and find your version of Anacounts 🥳

Note that in dev mode, the emails are not actually sent, they are displayed in an internal mailbox available at /internal/mailbox.