biancini / codegouvfr

Frontend to display public sector source code repositories

codegouvfr

Browse public sector source code repositories.

This frontend retrives information source code repositories and organizations from the french public sector. The source code for creating these endpoints can be found here.

Develop

~$ git clone https://github.com/etalab/codegouvfr
~$ cd codegouvfr/
~$ lein test
~$ lein fig:build

Then 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
CODEGOUVFR_ADMIN_EMAIL: the email where to receive messages
CODEGOUVFR_FROM: the From header for sent emails
CODEGOUVFR_PORT: the port to run the application
CODEGOUVFR_MSGID_DOMAIN: what fqdn to use to build the message-id

Deploy with lein uberjar

~$ git clone https://github.com/etalab/codegouvfr
~$ cd codegouvfr/
~$ lein clean
~$ lein fig:min
~$ lein uberjar
~$ java -jar target/codegouvfr-standalone.jar

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

Deploy with Docker

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

~$ git clone https://github.com/etalab/codegouvfr
~$ cd codegouvfr/
~$ lein fig:min
~$ lein uberjar
~$ docker build -t codegouvfr .
~$ docker run -it -p 3000:3000 --env-file=~/.codegouvfr_envs codegouvfr

Then go to http://localhost:3000.

Roadmap

There is no real roadmap but you can check our issues to see if you can help or suggest a feature.

Contribute

Your help is welcome. You can contribute with bug reports, pull requests or feature requests.

Translation

The application was first available in french and will be soon available in english.

If you want to help with the translation:

• add a new file resources/public/index.[yourlanguagecode].html by copying resources/public/index.en.html
• add your language to src/cljc/codegouvfr/i18n.cljc
• add relevant variables to src/clj/codegouvfr/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 clojuriststogether.org.

License

2019 DINSIC, Bastien Guerry.

This application is published under the EPL 2.0 license.