Yazan-Ali-01/GeoJSON-API

GeoJSON API Locator

Very simple API that serves locations using GeoJSON data
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact

About The Project

Very simple API just to maximize the understanding of dealing with APIs with nodeJS and also to mess with some front-end vanilla JavaScript with the help of MapQuest API to do the geocoding in the backend and Map-box to deal with the front-end map and actually I deployed it, so you could take a look without hurting your head with local installing and running for the app So feel free to check it on https://puzzled-jade-cowboy-boots.cyclic.app

Here's why:

• I wanted to deal a little bit with API things like fetch and json stuff with a very simple project
• A Geocoding project is important to understand how geocoding works and how to deal with things like coordinates
• Vanilla JavaScript is important to deal with since it's very important to not rely on libraries and forget about the language that created them :)

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get started clone the repository and read the installation instructions below

Prerequisites

list of things you need to use the software

• npm

  npm install npm@latest -g

• MongoDB installed locally on your PC

Installation

_Below is an example of how you can install and set up the app locally.

1. Clone the repo

   git clone https://github.com/Yazan-Ali-01/GeoJSON-API.git

2. Install NPM packages

   npm install

3. Enter your environment variables in config/.env.example then change its name to .env only

   const MONGO_URI =
     "Here You Put Your Local MongoDB host like (mongodb://localhost:27017) OR your Atlas cluster connection URI";
   const GEOCODER_API_KEY = "Your MapQuest Geocoder Api Key";

4. start MongoDB local database server in your terminal with

   mongod

5. start application with npm run dev in the terminal
6. Run it in your browser on localhost:5000

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Email: yazan.ali.dev@gmail.com

Project Link: https://puzzled-jade-cowboy-boots.cyclic.app

(back to top)

(back to top)