You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-40Lines changed: 5 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,11 @@
3
3
[](https://developersitalia.slack.com/messages/CAM3F785T)
This is a Go, web interface validator for [publiccode.yml](https://github.com/italia/publiccode.yml) files, using [publiccode-parser-go](https://github.com/italia/publiccode-parser-go).
6
+
A RESTful API for validating [publiccode.yml](https://github.com/italia/publiccode.yml)
7
+
files, using the [publiccode-parser-go](https://github.com/italia/publiccode-parser-go)
8
+
library.
7
9
8
-
publiccode.yml is an international standard for describing public software. It is expected to be published in the root of open source repositories. This parser performs syntactic and semantic validation according to the official spec.
9
-
10
-
## Features
11
-
12
-
See related project for details: [publiccode-parser-go](https://github.com/italia/publiccode-parser-go)
13
-
14
-
15
-
## Validation from command line
16
-
17
-
The repository also contains a tool used to validate publiccode.yml files locally.
10
+
## Usage
18
11
19
12
```bash
20
13
go run main.go
@@ -24,40 +17,12 @@ curl -X POST "http://localhost:3000/v1/validate"
24
17
--data-binary "@./publiccode.yml"
25
18
```
26
19
27
-
## Docker support
28
-
29
-
The repository has a *Dockerfile*, used to also build the production image, and a *docker-compose.yml* file to facilitate the local deployment.
30
-
31
-
To build the container, run:
32
-
33
-
```shell
34
-
docker-compose up [-d] [--build]
35
-
```
36
-
37
-
where:
38
-
39
-
**-d* execute the containers in background
40
-
41
-
**--build* forces the containers build
42
-
43
-
To destroy the container, use:
44
-
45
-
```shell
46
-
docker-compose down
47
-
```
48
-
49
-
50
20
## Contributing
51
21
52
22
Contributing is always appreciated.
53
23
Feel free to open issues, fork or submit a Pull Request.
54
24
If you want to know more about how to add new fields, check out [CONTRIBUTING.md](CONTRIBUTING.md). In order to support other country-specific extensions in addition to Italy some refactoring might be needed.
55
25
56
-
## See also
57
-
58
-
*[Developers Italia backend & crawler](https://github.com/italia/developers-italia-backend) - a Go crawler for PC.
59
-
*[publiccode-parser-go](https://github.com/italia/publiccode-parser-go) - a Go parser and validator for publiccode.yml files.
60
-
61
26
## Maintainers
62
27
63
28
This software is maintained by community maintainers.
@@ -66,5 +31,5 @@ This software is maintained by community maintainers.
0 commit comments