From 8feb6627c50a49e4792c25316a757dfda49ffa2d Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Tue, 11 Dec 2018 18:39:23 +0100 Subject: [PATCH 1/2] (doc) update README.md and client package.json - specify nodejs version - clearer setup process - cleanup of phoenix doc artifacts - prioritize manual install --- README.md | 59 ++++++++++++++++++++++--------------------------- js/package.json | 3 +++ 2 files changed, 30 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 53bbcf829..4f6188abc 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ # Mobilizon +Your federated organization and mobilization platform. Gather people with a convivial, ethical, and emancipating tool. + ## Development -### Docker - -Just run -``` -docker-compose up -d -``` -to start a database container, an API container and the front-end dev container running on localhost:80 - ### Manual #### Server - * Install Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html) - * Install PostgreSQL - * Start postgres and make sure the postgis extension is installed. - * Create a postgres user with database creation capabilities, using the - following: `createuser -d -P elixir` and set `elixir` as the password. - * Fetch dependencies with `mix deps.get`. - * 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` + * Install dependencies: + * 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`. + * PostgreSQL + * 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; ``` + ``` create extension if not exists postgis; ``` - * Run migrations: `mix ecto.migrate`. + * Run migrations: `mix ecto.migrate`. * Start Phoenix endpoint with `mix phx.server`. Now you can visit [`localhost:4000`](http://localhost:4000) from your browser @@ -37,21 +35,18 @@ and see the website (server *and* client) in action. If you plan to specifically change the client side (frontend), do the following once the server is running: - * Install the latest version of NodeJS - * Change directory to `js/`. - * Install JavaScript package dependencies: `npm install`. - * Run the developement server in watch mode: `npm run dev`. This will open a - browser on [`localhost:8080`](http://localhost:8080) that gets - automatically reloaded on change. + * Install the latest version of NodeJS ![](https://img.shields.io/badge/node-%3E%3D%2011.4.0-brightgreen.svg) + * 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`](http://localhost:8080) that gets + automatically reloaded on change. -## Production +### Docker -Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment). +Just run `docker-compose up -d` to start a database container, an API container and the front-end dev container running on localhost. ## Learn more - * Official website: http://www.phoenixframework.org/ - * Guides: http://phoenixframework.org/docs/overview - * Docs: https://hexdocs.pm/phoenix - * Mailing list: http://groups.google.com/group/phoenix-talk - * Source: https://github.com/phoenixframework/phoenix + * Official website: https://joinmobilizon.org/ + * Source: https://framagit.org/framasoft/mobilizon diff --git a/js/package.json b/js/package.json index 32409beaa..4b3fadcaa 100644 --- a/js/package.json +++ b/js/package.json @@ -2,6 +2,9 @@ "name": "mobilizon", "version": "0.1.0", "private": true, + "engines" : { + "node" : ">=11.4.0" + }, "scripts": { "dev": "vue-cli-service serve", "build": "vue-cli-service build --modern", From 52a6bda1b01428137bb5d835e0521acc63d990c6 Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Wed, 12 Dec 2018 12:49:35 +0100 Subject: [PATCH 2/2] =?UTF-8?q?(doc)=20specify=20latest=20LTS=C2=A0and=20l?= =?UTF-8?q?ater=20as=20baseline?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- js/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f6188abc..ceae4ec50 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ and see the website (server *and* client) in action. If you plan to specifically change the client side (frontend), do the following once the server is running: - * Install the latest version of NodeJS ![](https://img.shields.io/badge/node-%3E%3D%2011.4.0-brightgreen.svg) + * Install the NodeJS (we guarantee support for the latest LTS and later) ![](https://img.shields.io/badge/node-%3E%3D%2010.0+-brightgreen.svg) * 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 diff --git a/js/package.json b/js/package.json index 4b3fadcaa..5216511e3 100644 --- a/js/package.json +++ b/js/package.json @@ -3,7 +3,7 @@ "version": "0.1.0", "private": true, "engines" : { - "node" : ">=11.4.0" + "node" : ">=10.0.0" }, "scripts": { "dev": "vue-cli-service serve",