Add instructions to start up libpostal + placeholder before starting pelias
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 269
- Forks
- 104
- PR merge metrics
- No merged PRs in 30d
Description
Start the API
After installing placeholder, start the service by navigating to the directory you installed it in, and running:
PORT=3000 npm start;
The port number 3000 corresponds to the port you specified in api.services.placeholder.url.
After installing go-whosonfirst-libpostal, start the service by navigating to the directory you installed it in, and running:
./bin/wof-libpostal-server -port 8080
The port number 8080 corresponds to the port you specified in api.services.libpostal.url (defaults to 8080).
Now that the API knows how to connect to Elasticsearch and all other Pelias services, all that is
required to start the API is:
npm start
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update the “Start the API” documentation section. Verify the placeholder command, the go-whosonfirst-libpostal server command, their configured ports, and the final npm start command; done means the instructions clearly describe starting these services before Pelias.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100