https://github.com/Wobbly-App/wobbly-server

Elixir backend for Wobbly
https://github.com/Wobbly-App/wobbly-server

Last synced: about 6 hours ago
JSON representation

Elixir backend for Wobbly

• Host: GitHub
• URL: https://github.com/Wobbly-App/wobbly-server
• Owner: Wobbly-App
• License: agpl-3.0
• Created: 2019-12-22T20:49:14.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-28T22:08:56.000Z (over 3 years ago)
• Last Synced: 2024-10-30T04:29:58.977Z (18 days ago)
• Language: Elixir
• Homepage: https://wobbly.app
• Size: 123 KB
• Stars: 15
• Watchers: 5
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-technostructure - Wobbly-App/wobbly-server - App/wobbly-server: Elixir backend for Wobbly ([🎓 research](https://github.com/stars/ketsapiwiq/lists/research))
• awesome-technostructure - Wobbly-App/wobbly-server - App/wobbly-server: Elixir backend for Wobbly ([🎓 research](https://github.com/stars/ketsapiwiq/lists/research))

README

        
# Wobbly Server [![Build Status](https://github.com/Wobbly-App/wobbly-server/workflows/Test/badge.svg?branch=master)](https://github.com/Wobbly-App/wobbly-server/actions?query=workflow%3ATest+branch%3Amaster) [![codecov](https://codecov.io/gh/Wobbly-App/wobbly-server/branch/master/graph/badge.svg)](https://codecov.io/gh/Wobbly-App/wobbly-server) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

The backend server for [Wobbly](https://wobbly.app), written in Elixir.

Runs [ejabberd](https://www.ejabberd.im/), the XMPP server, with custom extensions.

* [Code of conduct](https://github.com/Wobbly-App/wobbly-frontend/blob/develop/CODE-OF-CONDUCT.md)

* [Contributing guide](https://github.com/Wobbly-App/wobbly-frontend/blob/develop/CONTRIBUTING.md)

## 💻 Up and running

We recommend using VS Code (this repo comes with a few recommended extensions), but it's optional.

### Prerequisites - MacOS

* `brew install elixir gd libyaml

* (when getting dependencies you may have to prefix the `mix` command with `env LDFLAGS="-L$(brew --prefix openssl)/lib" CFLAGS="-I$(brew --prefix openssl)/include" `

### Install and run

* Install dependencies with `mix deps.get`

* Start the server with `iex -S mix`

Now you can connect with an XMPP client.

## 🔥 Testing

TODO.

Just run `mix test`. Make sure you have a Postgres database running.

## 🛠️ Contributing

All CI checks must pass for PRs to be merged. These checks are a lot more likely to succeed if you run `mix format` (to auto-format code), `mix credo` (to check code style), and `mix test` before pushing.

## 🐛 Debugging

Running into issues with the VS Code debugger? Try deleting the `.elixir_ls`, `deps`, and `_build` folders and restarting VS Code.

🖤 🐈