From 3c624d0c456fc5a3d7e566f56b52fced4a5fc037 Mon Sep 17 00:00:00 2001 From: Aniket Shahane Date: Wed, 24 Feb 2021 14:46:00 +0530 Subject: Add additional information in the readme file. The 'make serve' command --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 71269c6..7fad947 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -
-`fatcat-scholar` / Internet Archive Scholar -=========================================== +# `fatcat-scholar` / Internet Archive Scholar This is source code for [scholar.archive.org](https://scholar.archive.org), a full-text web search interface over the 25+ million open research papers in the @@ -15,16 +13,15 @@ handled by the [fatcat](https://fatcat.wiki) service; this service is just a ba search interface. Unlike the basic fatcat.wiki search, this index allows querying the full content of papers when available. - ## Overview This repository is fairly small and contains: -- `fatcat_scholar/`: Python code for web service and indexing pipeline -- `fatcat_scholar/templates/`: HTML template for web interface -- `tests/`: Python test files -- `proposals/`: design documentation and change proposals -- `data/`: empty directory for indexing pipeline +- `fatcat_scholar/`: Python code for web service and indexing pipeline +- `fatcat_scholar/templates/`: HTML template for web interface +- `tests/`: Python test files +- `proposals/`: design documentation and change proposals +- `data/`: empty directory for indexing pipeline A data pipeline converts groups of one or more fatcat "release" entities (grouped under a single "work" entity) into a single search index document. @@ -36,7 +33,6 @@ The current Python web framework is FastAPI, though the number of routes is very small and it would be easy to switch to a more conventional framework like Flask. - ## Getting Started for Developers You need `pipenv` and Python 3.8 installed. Most tasks are run using a @@ -54,6 +50,10 @@ then run the tests (to ensure everything is working): make test +To start the web interface run: + + make serve + While developing the web interface, you will almost certainly need an example database running locally. A docker-compose file in `extra/docker/` can be used to run Elasticsearch 7.x locally. The `make dev-index` command will reset the @@ -69,7 +69,6 @@ automatically. This repository uses `black` for code formatting; please run `make fmt` and `make lint` for submitting a pull request. - ## Contributing Software, copy-editing, translation, and other contributions to this repository @@ -91,4 +90,3 @@ the license terms when making your first contribution. For software developers, the "help wanted" tag in Github Issues is a way to discover bugs and tasks that external folks could contribute to. - -- cgit v1.2.3