@tricoteuses/tisseuse 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Tricoteuses Tisseuse
2
2
 
3
- _Add links to French legislative documents_
3
+ _Find links in/to French legislative documents_
4
4
 
5
5
  By: Emmanuel Raviart <mailto:emmanuel@raviart.com>
6
6
 
package/README.md CHANGED
@@ -1,5 +1,40 @@
1
1
  # Tricoteuses Tisseuse
2
2
 
3
- _Add links to French legislative documents_
3
+ _Find links in/to French legislative documents_
4
+
5
+ _Tricoteuses Tisseuse is free and open source software.
6
+
7
+ - [software repository](https://git.tricoteuses.fr/logiciels/tricoteuses-juridique/src/branch/main/packages/tisseuse)
8
+ - [GNU Affero General Public License version 3 or greater](https://git.tricoteuses.fr/logiciels/tricoteuses-juridique/src/branch/main/packages/tisseuse/LICENSE.md)
4
9
 
5
10
  Tricoteuses Tisseuse started from a full rewrite of [Metslesliens](https://www.npmjs.com/package/metslesliens) by Seb35, published under the "DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE" (WTFPL) version 2.
11
+
12
+ ## Installation
13
+
14
+ ### Create database
15
+
16
+ Using Debian GNU/Linux, install PostgreSQL, then:
17
+
18
+ ```sh
19
+ sudo su - postgres
20
+ createuser tisseuse -P # and enter the password
21
+ createdb -O tisseuse tisseuse
22
+ psql tisseuse
23
+ CREATE EXTENSION IF NOT EXISTS pg_trgm;
24
+ \q
25
+ exit
26
+ ```
27
+
28
+ ### Install dependencies
29
+
30
+ ```sh
31
+ npm install
32
+ ```
33
+
34
+ ## Server Configuration
35
+
36
+ Create a `.env` file to set configuration variables (you can use `example.env` as a template). Then:
37
+
38
+ ```sh
39
+ npm run configure
40
+ ```