mirror of
https://github.com/LukasDzenk/reverse-geocoder.git
synced 2026-05-28 14:07:30 +00:00
No description
- TypeScript 76.5%
- JavaScript 9.2%
- Dockerfile 7.4%
- HTML 4.1%
- Shell 2.8%
| .github/workflows | ||
| .husky | ||
| docker/app | ||
| src | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.cjs | ||
| eslint.config.js | ||
| migrate-mongo-config.js | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| readme.md | ||
| tsconfig.json | ||
| vitest.config.ts | ||
reverse-geocoder
Description
reverse-geocoder is a Node.js project that maps coordinates to a city / municipality / country / region / country.
API documentation
The OpenAPI specification lives at src/public/docs/api.yaml. To view it:
- Paste the file contents into Swagger Editor for a quick preview.
- Or import it into Postman as an "API" definition to generate a documentation/collection (guide).
Setup
Prerequisites
- pnpm package manager
- Node.js (check if you are running a sufficient local version by comparing it to the value of "node" in
package.json"engines" property)
Installation
pnpm install
Running the project
Development environment
pnpm dev
Production environment
pnpm build
And then:
pnpm start
Testing
Run all tests
pnpm test