https://github.com/zafar-saleem/nearby
https://github.com/zafar-saleem/nearby
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/zafar-saleem/nearby
- Owner: zafar-saleem
- Created: 2022-02-13T15:43:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-16T11:04:04.000Z (over 3 years ago)
- Last Synced: 2025-01-01T03:27:38.579Z (10 months ago)
- Language: TypeScript
- Size: 670 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
A sample project that lists restaurants in 1km proximity of current location(by default the current longitudes and latitudes are set to Tokyo which is not changeable in UI however, it can be changed in the code). The list of restaurants are shown in Cards via Grid layout. We can filter the lis tof restaurants and also can see each individual restaurant in its own details page.
## Getting started
In order to run this project in the browser successfully, please follow the steps below!
1. Clone this repository.
2. cd into `nearby` folder.
3. Run `yarn` command to download and install all dependencies.
4. To run this project use `yarn start:dev` command in command line.
## [Table of contents](https://doc.clickup.com/d/h/13meh7-104/5181fd91c657a40/13meh7-124)
1. [Getting Started](https://doc.clickup.com/p/h/13meh7-144/74cf4e17e5fdd9c)
2. [Requirements](https://doc.clickup.com/p/h/13meh7-164/fe920211ad92c5d)
3. [Development Process](https://doc.clickup.com/p/h/13meh7-184/0b383f372157773)
4. [Git Workflow](https://doc.clickup.com/p/h/13meh7-204/50598c0ae869647)
5. [DevOps](https://doc.clickup.com/p/h/13meh7-224/87fb3f130a6c3bb)
6. [Architecture](https://doc.clickup.com/p/h/13meh7-244/eb78e4e854a8789)
7. [Performance](https://doc.clickup.com/p/h/13meh7-264/f763728d92e6bd1)
## Live Demo
To view live demo please [click here](https://nearbylab.herokuapp.com/).
To view a video [click here](https://youtu.be/PZdF6MxdkQE).
To view documentation please [click here](https://doc.clickup.com/d/h/13meh7-104/5181fd91c657a40/13meh7-124).
To view Trello Board please [click here](https://trello.com/b/PGCflPKQ/nearby).
To view list of CI/CD workflows/pipelines [click here](https://github.com/zafar-saleem/nearby/actions).
To view DevOps diagram [click here](https://app.terrastruct.com/diagrams/48663441#layer=1452984355).
To view git branch strategy [click here](https://swimlanes.io/u/AamK0JAbV).
To view list of all commits [click here](https://github.com/zafar-saleem/nearby/commits/master).
To view list of all branches [click here](https://github.com/zafar-saleem/nearby/branches/all).
To view list of all pull requests [click here](https://github.com/zafar-saleem/nearby/pulls?q=is%3Apr+is%3Aclosed).
To view architecture diagram [click here](https://app.terrastruct.com/diagrams/665704889).
[My Website](https://zafar-saleem.github.io/).