(doc) update README.md and client package.json
- specify nodejs version - clearer setup process - cleanup of phoenix doc artifacts - prioritize manual install
This commit is contained in:
parent
7cee8c2231
commit
8feb6627c5
59
README.md
59
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
|
||||
|
@ -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",
|
||||
|
Loading…
Reference in New Issue
Block a user