Go to file
Thomas Citharel 20fc579677 Merge branch 'feature/add-credo' into 'master'
Add Credo checks and refactor code

Closes #52

See merge request framasoft/mobilizon!40
2019-01-03 16:00:57 +01:00
config Change configuration and docker compose 2019-01-03 11:33:52 +01:00
docker Change configuration and docker compose 2019-01-03 11:33:52 +01:00
js Use includes instead of indexOf 2018-12-28 16:30:35 +01:00
lib Add Credo checks and refactor code 2019-01-03 15:52:48 +01:00
priv Work on actors 2018-12-03 11:58:57 +01:00
support/systemd Improve overall configuration and support 2018-11-15 17:35:47 +01:00
test Add Credo checks and refactor code 2019-01-03 15:52:48 +01:00
uploads Move to GraphQL 2018-11-06 10:30:27 +01:00
.credo.exs Add Credo checks and refactor code 2019-01-03 15:52:48 +01:00
.env.sample Change configuration and docker compose 2019-01-03 11:33:52 +01:00
.formatter.exs Remove credo and use mix format, and lint everything 2018-07-27 10:45:35 +02:00
.gitignore Fix vue appolo graphql middleware 2018-12-28 15:41:32 +01:00
.gitlab-ci.yml Add Credo checks and refactor code 2019-01-03 15:52:48 +01:00
.graphqlconfig.yaml Add GraphQL config file for https://github.com/graphql-cli/graphql-cli 2018-11-14 16:51:09 +01:00
CONTRIBUTING.md Add contribution guide 2018-11-14 14:40:25 +01:00
Dockerfile Change configuration and docker compose 2019-01-03 11:33:52 +01:00
LICENSE Rename project to Mobilizon 2018-10-11 17:37:39 +02:00
Makefile Add Makefile to setup things 2018-12-17 11:24:26 +01:00
README.md Mention Pleroma inside the README.md file 2018-12-27 11:31:16 +01:00
SECURITY.md Add SECURITY.md 2018-11-14 14:59:38 +01:00
docker-compose.yml Change configuration and docker compose 2019-01-03 11:33:52 +01:00
mix.exs Add Credo checks and refactor code 2019-01-03 15:52:48 +01:00
mix.lock Add Credo checks and refactor code 2019-01-03 15:52:48 +01:00

README.md

Mobilizon

Your federated organization and mobilization platform. Gather people with a convivial, ethical, and emancipating tool.

Development

Clone the repo, and start the project trough Docker. You'll need both Docker and Docker-Compose.

git clone https://framagit.org/framasoft/mobilizon && cd mobilizon
make

Manual

Server

  • Install dependencies:

  • Start services:

    • Start postgres
  • Setup services:

    • Make sure the postgis extension is installed on your system.

    • Create a postgres user with database creation capabilities, using the following: createuser -d -P elixir and set elixir as the password.

    • Create your database with mix ecto.create.

    • Create the postgis extension on the database with a postgres user that has superuser capabilities: psql mobilizon_dev

      create extension if not exists postgis;

    • Run migrations: mix ecto.migrate.

  • Start Phoenix endpoint with mix phx.server.

Now you can visit localhost:4000 from your browser and see the website (server and client) in action.

Client

If you plan to specifically change the client side (frontend), do the following once the server is running:

  • Install the NodeJS (we guarantee support for the latest LTS and later)
  • Change directory to js/ and do:
    • Install JavaScript package dependencies: npm install.
    • Run the developement server in watch mode: npm run dev. This will open a browser on localhost:8080 that gets automatically reloaded on change.

Docker

You need to install the latest supported Docker and Docker-Compose before using the Docker way of installing Mobilizon.

Just run :

make start

to start a database container, an API container and the front-end dev container running on localhost.

Learn more

Note: Most federation code comes from Pleroma, which is Copyright © 2017-2018 Pleroma Authors - AGPL-3.0