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

https://github.com/alejandrosuero/coffe-shops-near-you

A simple webapp to show the coffee shops that are near to you.
https://github.com/alejandrosuero/coffe-shops-near-you

Last synced: 3 months ago
JSON representation

A simple webapp to show the coffee shops that are near to you.

Awesome Lists containing this project

README

        

# Coffee Shops Near You

## Table of Contents

- [About](#about)
- [Getting Started](#getting-started)
- [License](#license)

## About

This is a simple web app that shows coffee shops near you.


(Back to top)

## Getting Started

To get a local copy up and running follow these simple steps.


(Back to top)

### Prerequisites

- [Node.js](https://nodejs.org/en/)
- [PNPM](https://pnpm.js.org/)
- [Docker](https://www.docker.com/)

### Installation

1. Clone the repo
```sh
git clone https://github.com/AlejandroSuero/coffe-shops-near-you.git
```
2. Install dependencies
```sh
pnpm install
```
3. Start the app
```sh
# If you have make installed
make run
# If you don't have make installed
docker compose build && docker compose up -d
```
4. Open [http://localhost:8080](http://localhost:8080) to see the app.


(Back to top)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.


(Back to top)