Skip to content

Commit f9c6e0d

Browse files
author
Perki
committed
Open sourcing
1 parent 3283d83 commit f9c6e0d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+465
-105
lines changed

.licenser.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
files:
2+
"**/*.js":
3+
header:
4+
startBlock: |
5+
/**
6+
* @license
7+
linePrefix: " * "
8+
endBlock: " */"
9+
10+
"**/package.json":
11+
json:
12+
force:
13+
author: "{AUTHOR_NAME} <{AUTHOR_EMAIL}> ({AUTHOR_WEB})"
14+
license: "{SPDX}"
15+
private: true
16+
defaults:
17+
homepage: "{HOMEPAGE}"
18+
description: "{DESCRIPTION}"
19+
sortPackage: true
20+
21+
siblingLicenseFile:
22+
name: "LICENSE"
23+
license: |
24+
Copyright (C) {YEARS} {AUTHOR_NAME} {AUTHOR_WEB}
25+
26+
This file is part of Open-Pryv.io and released under BSD-Clause-3 License
27+
28+
Redistribution and use in source and binary forms, with or without
29+
modification, are permitted provided that the following conditions are met:
30+
31+
1. Redistributions of source code must retain the above copyright notice,
32+
this list of conditions and the following disclaimer.
33+
34+
2. Redistributions in binary form must reproduce the above copyright notice,
35+
this list of conditions and the following disclaimer in the documentation
36+
and/or other materials provided with the distribution.
37+
38+
3. Neither the name of the copyright holder nor the names of its contributors
39+
may be used to endorse or promote products derived from this software
40+
without specific prior written permission.
41+
42+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
45+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
46+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
51+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52+
53+
SPDX-License-Identifier: BSD-3-Clause
54+
55+
"**/README.md":
56+
footer:
57+
startBlock: "\n\n## License\n\n"
58+
linePrefix: ""
59+
endBlock: ""
60+
license: "[{SPDX}](LICENSE)"
61+
62+
ignore:
63+
- .git
64+
- .vscode
65+
- coverage
66+
- node_modules
67+
- dest
68+
- service-core
69+
- service-mail
70+
- service-register
71+
72+
license: |
73+
Copyright (C) {AUTHOR_NAME} {AUTHOR_WEB}
74+
This file is part of Pryv.io and released under BSD-Clause-3 License
75+
Refer to LICENSE file
76+
77+
substitutions:
78+
YEARS:
79+
start: 2019
80+
end: CURRENT_YEAR
81+
AUTHOR_NAME: "Pryv"
82+
AUTHOR_EMAIL: info@pryv.com
83+
AUTHOR_WEB: https://pryv.com
84+
DESCRIPTION: "This package is part of Pryv.io, a Pryv software"
85+
HOMEPAGE: https://pryv.com
86+
SPDX: BSD-3-Clause

LICENSE

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Copyright (C) 2019–2025 Pryv https://pryv.com
2+
3+
This file is part of Open-Pryv.io and released under BSD-Clause-3 License
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice,
9+
this list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its contributors
16+
may be used to endorse or promote products derived from this software
17+
without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
30+
SPDX-License-Identifier: BSD-3-Clause

README.md

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Pryv.io Opener
22

3-
Script that releases the open source version of Pryv.io.
4-
3+
Script that releases the open-pryv.io a strip down version of service-core, service-mail and service-register.
4+
As of february 2025 All Pryv.io software has been open-sourced.
55

66
## Usage
77

@@ -35,45 +35,4 @@ Publish docker containers:
3535

3636
## License
3737

38-
License settings and script are located in [`licenser/`](licenser/).
39-
40-
41-
## Helpers for developpment
42-
43-
### Build
44-
In `dest/` run `just setup`, `just install`, `just build`
45-
46-
### Test
47-
tests have to runned component by component
48-
`cd dest/`
49-
- `just test {component}'`
50-
51-
52-
## Design
53-
54-
### service-core
55-
56-
Changes made on **service-core** legacy code base to make it openable
57-
58-
#### Integration of register as a component (used if DNSLESS = true)
59-
60-
- Added `/reg` route in `routes/Path.js`
61-
- Module is loaded directly from `server.js` with `expressApp` and `applications` parameters
62-
63-
### service-regiser
64-
65-
Changes made on **service-core** legacy code base to make it openable
66-
67-
This task had a very small impact on the code of register as the **node-app-opener** was able to strip out the necessary code.
68-
69-
Note the **striping comments** in `routes/admin.js` and `routes/user.js` that are used to remove parts of the code during build process of the open version.
70-
71-
Example:
72-
73-
The code between `// START - CLEAN ...` and `// END - CLEAN ...` will be removed
74-
75-
```javascript
76-
// START - CLEAN FOR OPENSOURCE
77-
const invitationToken = require('../storage/invitations');
78-
// END - CLEAN FOR OPENSOURCE
79-
```
38+
[BSD-3-Clause](LICENSE)

build/index.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const serviceCore = require('./service-core');
28
const serviceMail = require('./service-mail');
39
const serviceRegister = require('./service-register');

build/lib/json.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const path = require('path');
28
const fs = require('fs');
39

build/lib/rsync.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const Rsync = require('rsync');
28
const path = require('path');
39
const mkdirp = require('mkdirp');

build/lib/sed.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const { execSync } = require('child_process');
28
const path = require('path');
39

build/root.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const fs = require('fs');
28
const path = require('path');
39
const rsync = require('./lib/rsync');

build/service-core.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const path = require('path');
28
const fs = require('fs');
39

build/service-mail.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @license
3+
* Copyright (C) Pryv https://pryv.com
4+
* This file is part of Pryv.io and released under BSD-Clause-3 License
5+
* Refer to LICENSE file
6+
*/
17
const path = require('path');
28

39
const mkdirp = require('mkdirp');

0 commit comments

Comments
 (0)