Skip to content

Commit c313413

Browse files
maehrflicksolutionsSebastian Flickhenrikehoffmannkoilebeit
authored
first release of awesome-digital-history.pages.dev/ with SvelteKit (#59)
feat: SvelteKit page with Tailwind CSS, daisyUI, MDsveX, search params and unicorn sparkles and a11y with @flicksolutions feat: entries overhauled and more metadata added with @henrikehoffmann and @koilebeit feat: Automatic generation of README.md feat: tracking via plausible.io docs: CITATION.cff updated docs: issue and pull request template improved ci: awesome-lint.yml GitHub action updated Co-authored-by: Sebastian Flick <[email protected]> Co-authored-by: Sebastian Flick <[email protected]> Co-authored-by: Henrike Hoffmann <[email protected]> Co-authored-by: Henrike Hoffmann <[email protected]> Co-authored-by: Nico Görlich <[email protected]> Co-authored-by: Nico Görlich <[email protected]>
1 parent 0ceccc6 commit c313413

Some content is hidden

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

64 files changed

+5860
-3009
lines changed

.eslintignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
10+
# Ignore files for PNPM, NPM and YARN
11+
pnpm-lock.yaml
12+
package-lock.json
13+
yarn.lock

.eslintrc.cjs

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = {
2+
root: true,
3+
extends: ['eslint:recommended', 'prettier'],
4+
plugins: ['svelte3'],
5+
overrides: [{ files: ['*.svelte'], processor: 'svelte3/svelte3' }],
6+
parserOptions: {
7+
sourceType: 'module',
8+
ecmaVersion: 2020
9+
},
10+
env: {
11+
browser: true,
12+
es2017: true,
13+
node: true
14+
}
15+
};

.github/ISSUE_TEMPLATE/addition.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
---
22
name: Addition
3-
about: Create a report to add an item
4-
title: ''
5-
labels: ''
3+
about: Request to add an item from the list
4+
title: \[Addition\]
5+
labels: 'addition'
66
assignees: ''
77
---
88

9-
**Item**
9+
**Item Details**
1010

11-
- [Example](http://example.com) - Description.
11+
Please provide the following details about the item you want to add to the list:
1212

13-
**Rationale for the change**
13+
```json
14+
{
15+
"title": "",
16+
"description": "",
17+
"url": "",
18+
"region": [],
19+
"language": [],
20+
"type": [],
21+
"period": []
22+
}
23+
```
1424

15-
Briefly and concisely explain why you want to change the list.
25+
Check [maehr.github.io/awesome-digital-history/](https://maehr.github.io/awesome-digital-history/) for the list of available regions, languages, types, and periods.
1626

17-
Please note that this project is released with a
18-
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
19-
project you agree to abide by its terms.
27+
**Rationale for the addition**
28+
29+
Briefly explain why you think this item should be added to the list and how it fits the criteria for inclusion.
30+
31+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

.github/ISSUE_TEMPLATE/change.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Change request
3+
about: Request to change an item from the list
4+
title: \[Change\]
5+
labels: 'change'
6+
assignees: ''
7+
---
8+
9+
**Item Details**
10+
11+
Please provide the following details about the item you want to change:
12+
13+
- old entry
14+
15+
```json
16+
{
17+
"title": "",
18+
"description": "",
19+
"url": "",
20+
"region": [],
21+
"language": [],
22+
"type": [],
23+
"period": []
24+
}
25+
```
26+
27+
- new entry
28+
29+
```json
30+
{
31+
"title": "",
32+
"description": "",
33+
"url": "",
34+
"region": [],
35+
"language": [],
36+
"type": [],
37+
"period": []
38+
}
39+
```
40+
41+
Check [maehr.github.io/awesome-digital-history/](https://maehr.github.io/awesome-digital-history/) for the list of available regions, languages, types, and periods.
42+
43+
**Item to be changed**
44+
45+
Please provide the title of the item you wish to change and a link to it, if applicable.
46+
47+
**Reason for change(s)**
48+
49+
Briefly explain why you believe this item should be changed.
50+
51+
**Proposal for change(s)**
52+
53+
Please provide / suggest changes [noch besser formulieren]
54+
55+
**Additional context**
56+
57+
Add any other context or screenshots about the change request here.
58+
59+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

.github/ISSUE_TEMPLATE/edit.md

-19
This file was deleted.

.github/ISSUE_TEMPLATE/removal.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
---
2-
name: Removal
3-
about: Create a report to remove an item
4-
title: ''
5-
labels: ''
2+
name: Removal Request
3+
about: Request to remove an item from the list
4+
title: \[Removal\]
5+
labels: 'removal'
66
assignees: ''
77
---
88

9-
**Item**
9+
**Item to be Removed**
1010

11-
- [Example](http://example.com) - Description.
11+
Please provide the title of the item you wish to remove and a link to it, if applicable.
1212

13-
**Rationale for the change**
13+
**Reason for Removal**
1414

15-
Briefly and concisely explain why you want to change the list.
15+
Briefly explain why you believe this item should be removed from the list.
1616

17-
Please note that this project is released with a
18-
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
19-
project you agree to abide by its terms.
17+
**Alternative(s)**
18+
19+
Are there any alternatives that could be added to the list in place of this item?
20+
21+
**Additional context**
22+
23+
Add any other context or screenshots about the removal request here.
24+
25+
Please note that this project is governed by a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

.github/pull_request_template.md

+41-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,48 @@
1-
Add / Remove / Edit {entry name} to/from the "{section name}" section.
1+
## Pull Request
2+
3+
Add / Remove / Change `{entry name}` in `src/lib/data/entries.json`.
4+
5+
<!-- NOTE: Please do not skip the template -->
26

37
**Short pitch**
48

5-
Describe why this change is made. Alternatively, refer to existing issues if
6-
any. You could try to answer:
9+
Describe why this change is made. Alternatively, refer to existing issues if any. You could try to answer:
710

8-
- Why do / don't you find this tool awesome?
9-
- How do you use this tool in your workflow?
10-
- What advantages / disadvantages does it have compared to {another tool}?
11+
- Why do you find this resource awesome?
12+
- How do you use this resource in your workflow?
13+
- What advantages / disadvantages does it have compared to {another resource}?
1114

12-
## Checklist
15+
### Checklist
1316

14-
- [ ] I have read and understood the [contribution guidelines](https://github.com/writing-resources/awesome-scientific-writing/blob/main/CONTRIBUTING.md).
15-
- [ ] Table of contents has been updated (if a section is added / removed).
16-
- [ ] Contents have been sorted alphabetically.
17+
Please ensure that you have completed the following tasks:
1718

18-
<!-- NOTE: Please do not skip the template -->
19+
- [ ] I have read and understood the [contribution guidelines](CONTRIBUTING.md).
20+
- [ ] I have run `npm run prepare` to sort the entries in `src/lib/data/entries.json` alphabetically and to generate the `README.md` file.
21+
- [ ] I have run `npm run format` to format the repository code.
22+
- [ ] I have run `npm run awesome-lint` to ensure that the `README.md` file is formatted correctly.
23+
24+
### Criteria for accepting a pull request
25+
26+
_Contributors, please ensure that_:
27+
28+
- A **short pitch** is included in the pull request description.
29+
- The addition you proposed is NOT part of [everything that did not make it into the list](https://github.com/maehr/awesome-digital-history/wiki).
30+
31+
_Maintainers, please ensure that_:
32+
33+
- The above criteria are followed.
34+
- The tests pass on the CI.
35+
- In the case of addition or removal, make an assessment of the awesomeness of the entry.
36+
37+
### Updating your PR
38+
39+
If the maintainers notice anything that needs to be changed, they will ask you to edit your PR before merging it. Please do not open a new PR, just edit the existing one. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) on the different ways you can update your PR.
40+
41+
### Appendix: running lint tests
42+
43+
To run tests locally using Node.js, you need to install the dependencies first:
44+
45+
```bash
46+
npm install
47+
npm run prepare
48+
```

.github/workflows/awesome-lint.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
Awesome_Lint:
77
runs-on: ubuntu-latest
88
steps:
9-
- uses: actions/checkout@v2
9+
- uses: actions/checkout@v3
1010
with:
1111
fetch-depth: 0
1212
- run: npx awesome-lint

.gitignore

+33-9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
vite.config.js.timestamp-*
10+
vite.config.ts.timestamp-*
111

212
# Created by https://www.toptal.com/developers/gitignore/api/git,linux,macos,node,dotenv,windows,visualstudiocode
313
# Edit at https://www.toptal.com/developers/gitignore?templates=git,linux,macos,node,dotenv,windows,visualstudiocode
@@ -64,6 +74,10 @@ Network Trash Folder
6474
Temporary Items
6575
.apdisk
6676

77+
### macOS Patch ###
78+
# iCloud generated files
79+
*.icloud
80+
6781
### Node ###
6882
# Logs
6983
logs
@@ -121,6 +135,9 @@ web_modules/
121135
# Optional eslint cache
122136
.eslintcache
123137

138+
# Optional stylelint cache
139+
.stylelintcache
140+
124141
# Microbundle cache
125142
.rpt2_cache/
126143
.rts2_cache_cjs/
@@ -136,9 +153,11 @@ web_modules/
136153
# Yarn Integrity file
137154
.yarn-integrity
138155

139-
# dotenv environment variables file
140-
.env.test
141-
.env.production
156+
# dotenv environment variable files
157+
.env.development.local
158+
.env.test.local
159+
.env.production.local
160+
.env.local
142161

143162
# parcel-bundler cache (https://parceljs.org/)
144163
.cache
@@ -161,6 +180,12 @@ dist
161180
# vuepress build output
162181
.vuepress/dist
163182

183+
# vuepress v2.x temp and cache directory
184+
.temp
185+
186+
# Docusaurus cache and generated files
187+
.docusaurus
188+
164189
# Serverless directories
165190
.serverless/
166191

@@ -188,7 +213,6 @@ dist
188213
.webpack/
189214

190215
# Optional stylelint cache
191-
.stylelintcache
192216

193217
# SvelteKit build / generate output
194218
.svelte-kit
@@ -199,19 +223,19 @@ dist
199223
!.vscode/tasks.json
200224
!.vscode/launch.json
201225
!.vscode/extensions.json
202-
*.code-workspace
226+
!.vscode/*.code-snippets
203227

204228
# Local History for Visual Studio Code
205229
.history/
206230

231+
# Built Visual Studio Code Extensions
232+
*.vsix
233+
207234
### VisualStudioCode Patch ###
208235
# Ignore all local history of files
209236
.history
210237
.ionide
211238

212-
# Support for Project snippet scope
213-
!.vscode/*.code-snippets
214-
215239
### Windows ###
216240
# Windows thumbnail cache files
217241
Thumbs.db
@@ -238,4 +262,4 @@ $RECYCLE.BIN/
238262
# Windows shortcuts
239263
*.lnk
240264

241-
# End of https://www.toptal.com/developers/gitignore/api/git,linux,macos,node,dotenv,windows,visualstudiocode
265+
# End of https://www.toptal.com/developers/gitignore/api/git,linux,macos,node,dotenv,windows,visualstudiocode

.husky/pre-commit

-5
This file was deleted.

.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
engine-strict=true

.prettierignore

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
CODE_OF_CONDUCT.md
2+
LICENSE.md
3+
4+
.DS_Store
5+
node_modules
6+
/build
7+
/.svelte-kit
8+
/package
9+
.env
10+
.env.*
11+
!.env.example
12+
13+
# Ignore files for PNPM, NPM and YARN
14+
pnpm-lock.yaml
15+
package-lock.json
16+
yarn.lock

.prettierrc

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,8 @@
22
"useTabs": true,
33
"singleQuote": true,
44
"trailingComma": "none",
5-
"printWidth": 100
5+
"printWidth": 100,
6+
"plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
7+
"pluginSearchDirs": ["."],
8+
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
69
}

0 commit comments

Comments
 (0)