Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andre-ols/geo-location-with-postgres

Geolocation system implemented using Postgres database.
https://github.com/andre-ols/geo-location-with-postgres

Last synced: 4 days ago
JSON representation

Geolocation system implemented using Postgres database.

Host: GitHub
URL: https://github.com/andre-ols/geo-location-with-postgres
Owner: andre-ols
License: mit
Created: 2022-09-02T15:03:38.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-09-02T15:24:57.000Z (over 2 years ago)
Last Synced: 2024-11-13T16:50:44.676Z (2 months ago)
Language: TypeScript
Size: 80.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        ![Badge](https://img.shields.io/static/v1?label=NodeJs&message=16.14.2&color=339933&logo=node.js&link=https://nodejs.org/en/)

![Badge](https://img.shields.io/static/v1?label=NestJs&message=9.0.0&color=E0234E&logo=nestjs&link=https://nestjs.com/)

![Badge](https://img.shields.io/static/v1?label=PNPM&message=7.8.0&color=2C8EBB&logo=pnpm&link=https://pnpm.io/)

![badge](https://img.shields.io/github/last-commit/andre-ols/geolocation-with-postgres)

![badge](https://img.shields.io/static/v1?label=license&message=MIT&color)

# Geo-location with Postgres



  This project is a simple example of how to use Postgres with Geo-location. The entire project runs with docker



### How to Install

Before starting, you will need to have the following tools installed on your machine:

[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/), [Docker](https://www.docker.com/), [Pnpm](https://pnpm.io/).

Besides, it's good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/)

### 🎲 Running the Application

```bash

# Clone this repository

$ git clone https://github.com/andre-ols/geo-location-with-postgres.git

# access the project folder in the terminal/cmd

$ cd geo-location-with-postgres

# Fill the .env.development with the database access credentials

# Start the server using docker:

$ pnpm docker:up

```

### How to use the Application 🚀

- To start the application, just type `pnpm docker:up` in the terminal/cmd.

- Open the documentation in the browser: http://localhost:3000/api

### 🛠 Technologies Used

The following tools were used in building the project:

- [Node.js](https://nodejs.org/en/)

- [Pnpm](https://pnpm.io/)

- [Git](https://git-scm.com/)

- [Docker](https://www.docker.com/)

- [NestJs](https://nestjs.com/)

- [Postgres](https://www.postgresql.org/)

- [PostGIS](https://postgis.net/)

- [TypeORM](https://typeorm.io/#/)

- [Swagger](https://swagger.io/)

### Author




[![Linkedin Badge](https://img.shields.io/badge/-André-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/)](https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/)

[![Gmail Badge](https://img.shields.io/badge/[email protected]?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])

## License

This project is under the license [MIT](./LICENSE).

Made with ❤️ by André Oliveira!