Add Makefile to setup things
This commit is contained in:
parent
ccc623bc31
commit
74ba3e0cb6
14
Makefile
Normal file
14
Makefile
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
init:
|
||||||
|
@bash docker/message.sh "start"
|
||||||
|
make start
|
||||||
|
|
||||||
|
start: stop
|
||||||
|
@bash docker/message.sh "starting MobiliZon with docker"
|
||||||
|
docker-compose up -d
|
||||||
|
@bash docker/message.sh "started"
|
||||||
|
stop:
|
||||||
|
@bash docker/message.sh "stopping MobiliZon"
|
||||||
|
docker-compose down
|
||||||
|
@bash docker/message.sh "stopped"
|
||||||
|
|
||||||
|
target: init
|
18
README.md
18
README.md
|
@ -3,12 +3,17 @@
|
||||||
Your federated organization and mobilization platform. Gather people with a convivial, ethical, and emancipating tool.
|
Your federated organization and mobilization platform. Gather people with a convivial, ethical, and emancipating tool.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
Clone the repo, and start the project via Docker
|
||||||
|
```bash
|
||||||
|
git clone https://framagit.org/framasoft/mobilizon
|
||||||
|
make
|
||||||
|
```
|
||||||
### Manual
|
### Manual
|
||||||
|
|
||||||
#### Server
|
#### Server
|
||||||
|
|
||||||
* Install dependencies:
|
* Install dependencies:
|
||||||
|
|
||||||
* Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html)
|
* Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html)
|
||||||
* Fetch backend Elixir dependencies with `mix deps.get`.
|
* Fetch backend Elixir dependencies with `mix deps.get`.
|
||||||
* PostgreSQL
|
* PostgreSQL
|
||||||
|
@ -43,10 +48,19 @@ once the server is running:
|
||||||
automatically reloaded on change.
|
automatically reloaded on change.
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
You need to install the latest supported [Docker](https://docs.docker.com/install/#supported-platforms) and [Docker-Compose](https://docs.docker.com/compose/install/) before using the Docker way of installing Mobilizon.
|
||||||
|
|
||||||
Just run `docker-compose up -d` to start a database container, an API container and the front-end dev container running on localhost.
|
Just run :
|
||||||
|
```bash
|
||||||
|
make start
|
||||||
|
```
|
||||||
|
to start a database container, an API container and the front-end dev container running on localhost.
|
||||||
|
|
||||||
## Learn more
|
## Learn more
|
||||||
|
|
||||||
* Official website: https://joinmobilizon.org/
|
* Official website: https://joinmobilizon.org/
|
||||||
* Source: https://framagit.org/framasoft/mobilizon
|
* Source: https://framagit.org/framasoft/mobilizon
|
||||||
|
* Riot/Matrix: https://riot.im/app/#/room/#Mobilizon:matrix.org
|
||||||
|
* Mastodon: https://framapiaf.org/@mobilizon
|
||||||
|
* Forum: https://framacolibri.org/c/mobilizon/fr-francais
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ services:
|
||||||
volumes:
|
volumes:
|
||||||
- './js:/app/js'
|
- './js:/app/js'
|
||||||
ports:
|
ports:
|
||||||
- "80:8080"
|
- "8888:8080"
|
||||||
entrypoint: entrypoint
|
entrypoint: entrypoint
|
||||||
|
|
||||||
api:
|
api:
|
||||||
|
@ -31,6 +31,7 @@ services:
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgres
|
- postgres
|
||||||
environment:
|
environment:
|
||||||
|
MIX_ENV: dev
|
||||||
POSTGRES_PASSWORD: postgres
|
POSTGRES_PASSWORD: postgres
|
||||||
POSTGRES_USER: postgres
|
POSTGRES_USER: postgres
|
||||||
POSTGRES_DATABASE: mobilizon_dev
|
POSTGRES_DATABASE: mobilizon_dev
|
||||||
|
|
7
docker/message.sh
Normal file
7
docker/message.sh
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
GREEN='\033[0;32m'
|
||||||
|
NC='\033[0m' # No Color
|
||||||
|
echo -e "${GREEN}########################${NC}"
|
||||||
|
echo -e "${GREEN} ${1} ${NC}"
|
||||||
|
echo -e "${GREEN}########################${NC}"
|
Loading…
Reference in a new issue