~etalab/sill.etalab.gouv.fr

ref: 33b91f00ab6c6f17279c57be87475033014ee92e sill.etalab.gouv.fr/README.org -rw-r--r-- 3.2 KiB
33b91f00 — Bastien Guerry README*: Update contributing instructions 2 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
* What is this repository?

This repository contains the source code for the SILL, the catalog of
recommended free software for the public sector.

The list of software itself is maintained [[https://github.com/disic/sill][on this repository]].

[[file:sillweb.png]]

* Develop

: ~$ git clone https://github.com/etalab/sillweb
: ~$ cd sillweb/
: ~$ clj -M:test
: ~$ clj -M:run
: ~$ clj -M:fig

Check http://locahost:9500 then hack and see changes going live.
   
* Deploy

** Configure environment variables

You will need to configure these environment variables:

: SMTP_HOST: the host from which to send emails
: SMTP_LOGIN: the smtp login to use to send emails
: SMTP_PASSWORD: the smtp password to use to send emails
: SILLWEB_ADMIN_EMAIL: the email where to receive messages
: SILLWEB_FROM: the From header for sent emails
: SILLWEB_PORT: the port to run the application
: SILLWEB_MSGID_DOMAIN: what fqdn to use to build the message-id
: SILLWEB_STATIC_FILES_PATH: where to store static files (no trailing slash)

** Deploy as a jar

: ~$ git clone https://github.com/etalab/sillweb
: ~$ cd sillweb/
: ~$ clj -M:js
: ~$ clj -M:uberdeps
: ~$ java -cp target/sillweb.jar clojure.main -m sillweb.server

Then go to https://localhost:3000 or to your custom base URL.

** Deploy with Docker

Assuming your environments variables are stored in ~~/.sillweb_envs~
and you want to expose the 3000 port:

: ~$ git clone https://github.com/etalab/sillweb
: ~$ cd sillweb/
: ~$ clj -M:js
: ~$ clj -M:uberdeps
: ~$ docker build -t sillweb .
: ~$ docker run -it -p 3000:3000 --env-file=~/.sillweb_envs sillweb

Then go to http://localhost:3000.

* Roadmap

There is no real roadmap but you can check [[https://github.com/etalab/sillweb/issues][our issues]] to see if you
can help or suggest a feature.

* Contributing

The development of this repository happens on [[https://git.sr.ht/~etalab/sill.etalab.gouv.fr][the SourceHut
repository]].  

The code is also published on [[https://github.com/etalab/sill.etalab.gouv.fr][GitHub]] to reach more developers, but
please do not send pull requests there.

You can send *patches* by email using [[https://git-send-email.io/][git-send-email.io]].  For your
patches to be processed correctly, configure your local copy with
this:

: git config format.subjectPrefix 'PATCH sill.etalab.gouv.fr'

You can also contribute with bug reports, feature requests or general
questions by writing to [[mailto:~etalab/codegouvfr-devel@lists.sr.ht][~etalab/codegouvfr-devel@lists.sr.ht]].

** Translation

If you want to help with the translation:

- add your language to =src/cljc/sillweb/i18n.cljc=
- add relevant variables to =src/clj/sillweb/views.clj=

Hack and send a /pull request/, I would be happy to integrate your
contribution.

* Support the Clojure(script) ecosystem

If you like Clojure(script), please consider supporting maintainers by
donating to [[https://www.clojuriststogether.org][clojuriststogether.org]].

* Archived on Software Heritage

[[https://archive.softwareheritage.org/browse/origin/https://github.com/etalab/sill.etalab.gouv.fr/][https://archive.softwareheritage.org/badge/origin/https://github.com/etalab/sill.etalab.gouv.fr/?style=.svg]]

* License

2019-2021 DINUM, Bastien Guerry.

This application is published under the EPL 2.0 license.