https://github.com/beemi/geousercoords

User Geo coords
https://github.com/beemi/geousercoords

Last synced: 10 months ago
JSON representation

User Geo coords

• Host: GitHub
• URL: https://github.com/beemi/geousercoords
• Owner: beemi
• Created: 2023-11-05T11:50:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T11:35:16.000Z (over 2 years ago)
• Last Synced: 2023-12-15T12:43:44.498Z (over 2 years ago)
• Language: JavaScript
• Size: 179 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# User geo coordinates API

## Description

This is a simple API that returns the geo coordinates of a user based on the postcode provided.

## Installation

```bash

npm install express axios body-parser cors express helmet morgan

```

### Development

To run the app in development mode, run the following commandm which will start the mongodb instance and the app.

```bash

docker-compose up -d

```

Build the Docker image for local development

    

```bash

docker build -t user-geo-coordinates-api .

```

### Project structure

```bash

your-app/

│

├── src/

│   ├── models/                # Mongoose models / schemas.

│   │   └── ...

│   ├── routes/                # Express route definitions.

│   │   └── ...

│   ├── services/              # Business logic and service layer.

│   │   ├── postcodeService.js # Service for handling postcode-related operations.

│   │   └── externalApi.js     # This is where you'd interact with external APIs.

│   ├── config/                # Configuration files.

│   │   └── ...

│   ├── utils/                 # Utility functions and helpers.

│   │   └── ...

│   ├── middleware/            # Custom middleware for Express.

│   │   └── ...

│   ├── app.js                 # Express app setup.

│   └── server.js              # Server entry point.

│

├── package.json               # Project manifest.

└── ...

```

### Build Docker image

Using github actions, the docker image is built and pushed to docker hub.

```bash

docker run -p 3000:3000 -d \

  -e MONGO_INITDB_ROOT_USERNAME=newadmin \

  -e MONGO_INITDB_ROOT_PASSWORD=newpassword \

  -e MONGO_HOST=host.docker.internal \

  -e MONGO_PORT=27017 \

  -e MONGO_DB=newdatabase \

  your-app-name

```

### 🎨 API Documentation 

The API documentation is available at [http://localhost:3000/api-docs](http://localhost:3000/api-docs)

![API Documentation](docs/img_1.png)

### 📝 Deployment

Docker image is deployed to kubernetes cluster using github actions and helm.