Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/travishorn/wikigraph
https://github.com/travishorn/wikigraph
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/travishorn/wikigraph
- Owner: travishorn
- License: mit
- Created: 2024-06-12T19:58:24.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-14T11:18:30.000Z (7 months ago)
- Last Synced: 2024-06-15T04:52:15.365Z (7 months ago)
- Language: JavaScript
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wiki Graph
Crawl a Fandom.com wiki and store connections between pages.
Upcoming: view connections in a force-directed graph.
## Setup
Clone this repository:
```sh
git clone https://github.com/travishorn/wikigraph
```
Change into the repository directory:
```sh
cd wikigraph
```
Install the dependencies:
```sh
npm install
```
Migrate the database:
```sh
npm run migrate
```
Copy `.env.example` to `.env` and edit it with your configuration:
- `SITE_ID` - Something descriptive to identify the site being scraped
- `BASE_URL` - The base URL for the wiki site
- `MAIN_PAGE_ID` - The last part of the URL of the main page
- `RATE_LIMIT` - The number of milliseconds to wait between page requests
Run the crawler:
```sh
npm start
```
Data is stored in `dev.sqlite3` or `prod.sqlite3`. Particularly, look at the
`Edge` table to see connections between pages.
## To Do
- Visualize the connections using a force-directed graph
## License
The MIT License
Copyright 2024 Travis Horn
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.