Skip to content

feat(site): implement publications browsing site #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nipsysdev merged 10 commits into from
Sep 26, 2025
Merged

feat(site): implement publications browsing site #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e27dcab
feat(site): initial implementation of publications browsing site
nipsysdev Sep 25, 2025
76faff6
refactor(site): separate listing and detail handlers
nipsysdev Sep 26, 2025
45118a0
test(site): add unit tests for handlers and views
nipsysdev Sep 26, 2025
87d659b
feat(site): use picocss sand theme
nipsysdev Sep 26, 2025
ef1da82
feat(server): return 404 if hash is invalid
nipsysdev Sep 26, 2025
63defdb
feat(site): improve site design
nipsysdev Sep 26, 2025
0af4b86
test(site): fix locale dependent date expects
nipsysdev Sep 26, 2025
878f8dc
docs(readme): update api endpoints paths
nipsysdev Sep 26, 2025
facd8ec
chore: set version to 1.3.0
nipsysdev Sep 26, 2025
c668139
chore(server): update server start logs
nipsysdev Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ Options:

- Avoid running multiple crawl operations at the same time, as currently encountering database lock triggers an exception which ends the crawling (could be improved)

#### Serve - Starting the API server
#### Serve - Runs the API server and site

```
$ ethos serve --help
Usage: ethos serve [options]

Start the REST API server
Start the REST API server and site

Options:
-p, --port <number> Port to run the server on
Expand All @@ -99,7 +99,7 @@ Options:

### Endpoints

#### GET `/health`
#### GET `/api/health`

Health check endpoint to verify the API is running.

Expand All @@ -112,7 +112,7 @@ Health check endpoint to verify the API is running.
}
```

#### GET `/sources`
#### GET `/api/sources`

Get list of available sources for crawling.

Expand All @@ -136,7 +136,7 @@ Get list of available sources for crawling.
]
```

#### GET `/publications`
#### GET `/api/publications`

Retrieve publications with filtering and pagination.

Expand Down Expand Up @@ -174,7 +174,7 @@ Retrieve publications with filtering and pagination.
}
```

#### GET `/publications/:hash`
#### GET `/api/publications/:hash`

Retrieve a specific publication by its hash.

Expand Down
6 changes: 5 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ethos-crawler",
"version": "1.2.1",
"version": "1.3.0",
"description": "Web crawler and API for aggregating and serving digital rights organizations' publications.",
"bin": {
"ethos": "dist/ethos.js"
Expand Down Expand Up @@ -31,6 +31,7 @@
"build": "vite build",
"start": "node dist/ethos.js",
"crawl": "node dist/ethos.js crawl",
"serve": "node dist/ethos.js serve",
"test": "vitest run",
"test:integration": "INT_TEST=true vitest run src/tests/integration",
"test:coverage": "vitest run --coverage",
Expand Down Expand Up @@ -58,6 +59,8 @@
"express": "^5.1.0",
"inquirer": "^9.3.7",
"jsdom": "^26.1.0",
"marked": "^16.3.0",
"pug": "^3.0.3",
"puppeteer": "^24.20.0",
"turndown": "^7.2.1"
},
Expand All @@ -70,6 +73,7 @@
"@types/inquirer": "^9.0.9",
"@types/jsdom": "^21.1.7",
"@types/node": "^24.3.1",
"@types/pug": "^2.0.10",
"@types/turndown": "^5.0.5",
"@vitest/coverage-v8": "3.2.4",
"commitizen": "^4.3.1",
Expand Down
Loading