hamlab/mobilizon-frontend
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Documentation proofing

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

12
support/guides/development/development.md
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

8
support/guides/development/styleguide.md
View File

@@ -1,21 +1,21 @@
# Styleguide
# Elixir
## Elixir
We format our code with the Elixir Formatter and check for issues with [Credo](https://github.com/rrrene/credo) (a few rules are not blocking).
Please run those two commands before pushing code:
Please run these two commands before pushing code:
* `mix format`
* `mix credo`
These two commands must not return an error code, since they are required to pass inside CI.
# Front
## Front-end
We use `tslint` with the `tslint-config-airbnb` preset.
Errors should be reported when running in dev mode `yarn run dev` or when building a production bundle `yarn run build`.
Please run the following command before pushing code `yanr run lint`.
Please run the following command before pushing code `yarn run lint`.
This command must not return an error code, since it's required to pass inside CI.

2
support/guides/development/tests.md
View File

@@ -9,7 +9,7 @@ To launch all the tests:
mix test
```
If you want the coverage:
If you want test coverage:
```bash
mix coveralls.html