From 7b98674d0405a31d9cd638becdeaa628ff39c2f8 Mon Sep 17 00:00:00 2001 From: Ainali Date: Thu, 28 Nov 2019 15:59:33 +0100 Subject: [PATCH] polishing: removed some linebreaks, added links, fixed typos --- README.md | 61 ++++++++++++++++++++++--------------------------------- 1 file changed, 24 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 73ba8e75..b3fc8933 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # publiccode yml Editor ![Build Status](https://img.shields.io/circleci/project/github/italia/publiccode-editor/master.svg) ![Issues](https://img.shields.io/github/issues/italia/publiccode-editor.svg) ![License](https://img.shields.io/github/license/italia/publiccode-editor.svg) -> An editor to generate and/or validate a `publiccode.yml` file +> An editor to generate and/or validate a `publiccode.yml` file --- @@ -13,70 +13,58 @@ - [Setup](#setup) - [License](#license) - ## Description -This node app is meant to be used to generate a valid [`publiccode.yml`](https://github.com/italia/publiccode.yml) file. -By means of filling all the forms it is possible to automatically generate -a YAML file compatible with the latest version of the standard. -Such a file may be copied or downloaded locally in order to be inserterd in the -root of the target repository. +This node app is meant to be used to generate a valid [`publiccode.yml`](https://github.com/italia/publiccode.yml) file. +By means of filling all the forms it is possible to automatically generate a YAML file compatible with the latest version of the standard. +Such a file may be copied or downloaded locally in order to be inserted in the root of the target repository. -Furthermore, the app may be used as a validator. In fact, it is possible to -paste an already existing `publiccode.yml` file inside the editor or import it -by means of the *load* button. As such, the editor will validate the imported -document and eventually it will help to fix the existing issues. +Furthermore, the app may be used as a validator. In fact, it is possible to paste an already existing `publiccode.yml` file inside the editor or import it by means of the *load* button. As such, the editor will validate the imported document and eventually it will help to fix the existing issues. ## Demo -It is possible to try a live demo of the editor. -The demo can be found [here](https://publiccode-editor.developers.italia.it). -This version of the demo is automatically deployed from the master branch so it -should be considered stable. - +It is possible to try a live demo of the editor. +The demo can be found [here](https://publiccode-editor.developers.italia.it). +This version of the demo is automatically deployed from the master branch so it should be considered stable. -## Contributing +## Contributing Contributions are always welcome! -If you find some problems or glitches when using the app, we warmly encourage -you to file an issue using GitHub's issue tracking feature. -However, the `CONTRIBUTING.md` file located inside the root of the repo provides insightful details about how to collaborate in an efficient way with the community. +If you find some problems or glitches when using the app, we warmly encourage you to file an issue using GitHub's issue tracking feature. +However, the [`CONTRIBUTING.md`](CONTRIBUTING.md) file located inside the root of the repo provides insightful details about how to collaborate in an efficient way with the community. ### Setup #### Manual -This is a REACT app. As such, you need the basic tools to interact with it. -You can use [yarn](https://yarnpkg.com/lang/en/). +This is a REACT app. As such, you need the basic tools to interact with it. +You can use [yarn](https://yarnpkg.com/lang/en/). First clone (or download) the repository: ```shell $ git clone https://github.com/italia/publiccode-editor.git ``` -Then open a shell, navigate to the freshly downloaded folder and digit: +Then open a shell, navigate to the freshly downloaded folder and run: ```shell -$ yarn install +$ yarn install ``` to install the dependencies. Now, in order to run the development server locally, you should run: ```shell -$ yarn dev +$ yarn dev ``` -This will expose a webserver listening to port 3000. -As such, you may browse `http://127.0.0.1:3000` to check the app. +This will expose a webserver listening to port 3000. +As such, you may browse `http://127.0.0.1:3000` to check the app. ### URLs -All the URLs used throughout the app are stored in a dedicated file found in -`app/contents/costants.js` in order to be easily changed. +All the URLs used throughout the app are stored in a dedicated file found in +[`app/contents/constants.js`](src/app/contents/constants.js) in order to be easily changed. ### Elasticsearch Integration -Starting from release `1.1`, the iPA list is fetched from an Elasticsearch -instance. This endpoint is communicated by means of the `ELASTIC_URL` -environment variable. If the variable is not present, the app falls back into -using a simple input form for such a key. +Starting from release `1.1`, the iPA list is fetched from an Elasticsearch instance. This endpoint is communicated by means of the `ELASTIC_URL` environment variable. If the variable is not present, the app falls back into using a simple input form for such a key. #### Docker -If you want to fire a docker instance for deployment purposes, you can make use of the `Dockerfile` already in the root of the project. +If you want to fire a docker instance for deployment purposes, you can make use of the `Dockerfile` already in the root of the project. By running: ```bash $ docker build -t publiccode-editor . @@ -87,12 +75,11 @@ $ docker run -p 3000:80 publiccode-editor ``` you can run the docker container and see the results inside the browser at `localhost:80` -Alternatively you can opt for `docker-compose` way, just copy `.env-example` to `.env` and filling with your ES instance -and then run: +Alternatively you can opt for `docker-compose` way, just copy `.env-example` to `.env` and filling with your ES instance and then run: ```shell $ docker-compose up ``` And pointing your browser at `localhost:8100` ## License -This project is covered by a GNU Affero General Public License v3.0 or later. +This project is covered by a [GNU Affero General Public License v3.0 or later](LICENSE.md) license.