{"id":18401391,"url":"https://github.com/chaosdorf/mete","last_synced_at":"2025-04-07T07:31:28.885Z","repository":{"id":1538967,"uuid":"6045078","full_name":"chaosdorf/mete","owner":"chaosdorf","description":"Matekasse","archived":false,"fork":false,"pushed_at":"2024-10-21T14:35:23.000Z","size":33485,"stargazers_count":47,"open_issues_count":22,"forks_count":39,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-22T14:11:38.481Z","etag":null,"topics":["hacktoberfest","mate","mete","ruby","spacemarket-api"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chaosdorf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-10-02T13:16:36.000Z","updated_at":"2024-10-21T14:35:59.000Z","dependencies_parsed_at":"2024-11-06T03:18:39.760Z","dependency_job_id":null,"html_url":"https://github.com/chaosdorf/mete","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaosdorf%2Fmete","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaosdorf%2Fmete/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaosdorf%2Fmete/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaosdorf%2Fmete/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chaosdorf","download_url":"https://codeload.github.com/chaosdorf/mete/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247612031,"owners_count":20966647,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","mate","mete","ruby","spacemarket-api"],"created_at":"2024-11-06T02:38:41.965Z","updated_at":"2025-04-07T07:31:28.311Z","avatar_url":"https://github.com/chaosdorf.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![build status](https://travis-ci.org/chaosdorf/mete.svg?branch=master)](https://travis-ci.org/chaosdorf/mete)\n[![documentation status](https://inch-ci.org/github/chaosdorf/mete.svg?branch=master)](https://inch-ci.org/github/chaosdorf/mete)\n[![Code Climate](https://codeclimate.com/github/chaosdorf/mete/badges/gpa.svg)](https://codeclimate.com/github/chaosdorf/mete)\n[![test coverage](https://codeclimate.com/github/chaosdorf/mete/badges/coverage.svg)](https://codeclimate.com/github/chaosdorf/mete/coverage)\n\n# Matekasse\n\n![logo](public/favicon-196x196.png)\n\nKeep track of your donations!\n\nThis web application is for places where people can donate to get a drink. Just\ncreate an account, donate some money and count down while drinking Mate (or some\nother beverage).\n\nThis code is intended to be simple, full of security problems and lacking a lot\nof features. Please hack on it.\n\n\n## Getting started\n\n### As a user\n\n1. Access your mete instance\n\nmete doesn't have any kind of discoverability built in. If you know the URL of an instance, you can access it by simply pointing your browser there. Or use one of the apps:\n * Android App: (https://github.com/chaosdorf/meteroid)\n * iOS App: (https://github.com/chaosdorf/meteroid-ios)\n * Sailfish OS App: (https://github.com/r4mp/harbour-meteroid)\n * CLI App: (https://github.com/YtvwlD/metecli)\n * QML App: (https://github.com/YtvwlD/qmleteroid)\n\n2. Select your account\n\nThe first screen you'll see presents a list of users.\nIf you already have an account at this instance, go ahead and select it by tapping.\n\n![users page](doc/users_page.png)\n\nIf you don't, you can simply create one by pressing the 'new user' button.\nThis opens a screen where you can fill in a username, your email and an initial account balance.\n(You don't need to put your email there, it's just being used for [Gravatar](https://gravatar.com/).)\nAfter entering your details and confirming, you'll be presented your user page.\n\n![new user page](doc/new_user_page.png)\n\n3. Your user page\n\nHere, you can donate for stuff by simply tapping the product. Or you can modify or delete your account.\n\n![user page](doc/user_page.png)\n\n### As a developer of an app\n\nMete currently implements [version 1](https://space-market.github.io/API/preview/v1/) of the [Space-Market API](https://github.com/Space-Market/API). The endpoint is located at `/api/v1`.\n\nOut-of-date instances of mete provide an API at `/` that is somewhat similar.\nCurrent installations may provide legacy support at `/` but please don't depend on this if you're developing a client.\n\nPlease also don't parse the HTML returned by mete or anything not in `/api`.\n\n### As a developer of mete\n\nThanks for wanting to contribute. :)\n\nThis is a relatively standard Rails application (which means that most code resides in the `app` folder).\n\nIf you're new to the codebase you might want to take a look at the [issues labeled 'good first issue'](https://github.com/chaosdorf/mete/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).\n\nAlso, there are tests for most parts of the application in `test` if you want to take a look.\n\n### As an admin\n\nSo you want to set up an instance of mete? That's great!\n\nPlease be aware that mete doesn't currently have any configuration mechanism on the server side, so if you want to make changes to mete consider forking this repository, making your changes and rebasing regularily. (Please also open a pull request if you think your changes are vaguely useful for others.)\n\nYou can add products via a browser afterwards.\n\nThere are multiple ways to set up an instance:\n\n#### using our provided Docker image\n\nThere's the image [`chaosdorf/mete`](https://hub.docker.com/r/chaosdorf/mete) over at Docker hub.\nThis is built automatically on each push to `master`, but should still be stable enough. (We try to not break `master`.)\n\nHere's a minimal example using docker-compose:\n\n```yaml\nversion: \"3\"\nvolumes:\n  system:\n  database:\nservices:\n  db:\n    image: postgres:10-alpine\n    environment:\n      POSTGRES_PASSWORD: mete\n    volumes:\n      - database:/var/lib/postgresql/data\n  backend:\n    environment:\n      RAILS_ENV: production\n    image: chaosdorf/mete\n    volumes:\n      - system:/app/public/system\n    restart: on-failure\n    depends_on:\n      - db\n    ports:\n      - \"80:80\"\n```\n\nThis is missing some stuff (eg. backups), you might want to take a look at `docker-compose.yml`.\n\n(You can also build the image on your own, of course.)\n\n#### the \"traditional\" way\n\nYou can still run mete without Docker. It needs a few dependencies (mostly Ruby) and a database (Postgres and SQLite have been tested).\n\n```sh\nsudo apt install ruby ruby-dev bundler git zlib1g-dev libsqlite3-dev sqlite3 imagemagick nodejs\ngit clone https://github.com/chaosdorf/mete.git\ncd mete\n# adjust config/database.yml\nexport RAILS_ENV=production\nbundle install --path vendor/bundle\nbundle exec rake db:migrate\nbundle exec rake assets:precompile\nbundle exec rails server -b [::] -p 80 # or use a reverse proxy\n```\n\nAfter an update you'll need to repeat the last five steps.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchaosdorf%2Fmete","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchaosdorf%2Fmete","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchaosdorf%2Fmete/lists"}