Documentation proofing

This commit is contained in:
Armando Lüscher
2019-05-19 11:38:09 +02:00
committed by Thomas Citharel
parent f3ff8c5b1e
commit 2821e5f12a
10 changed files with 92 additions and 91 deletions

View File

@@ -1,5 +1,5 @@
# Development
Clone the repo, and start the project trough Docker. You'll need both Docker and Docker-Compose.
Clone the repo, and start the project through Docker. You'll need both Docker and Docker-Compose.
```bash
git clone https://framagit.org/framasoft/mobilizon && cd mobilizon
make
@@ -28,19 +28,19 @@ make
* Run migrations: `mix ecto.migrate`.
* Start Phoenix endpoint with `mix phx.server`.
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser
Now you can visit [`localhost:4000`](http://localhost:4000) in 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
If you plan to specifically change the client side (front-end), do the following
once the server is running:
* Install the NodeJS (we guarantee support for the latest LTS and later) ![](https://img.shields.io/badge/node-%3E%3D%2010.0+-brightgreen.svg)
* Install 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: `yarn install`.
* Run the developement server in watch mode: `yarn run dev`. This will open a
browser on [`localhost:8080`](http://localhost:8080) that gets
* Run the development server in watch mode: `yarn run dev`. This will open a
browser at [`localhost:8080`](http://localhost:8080) that gets
automatically reloaded on change.
## Docker