Im-Abhi / Treasure-Places

Share your favorite places with others.

Home Page:https://treasure-places.netlify.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Treasure-Places Netlify Status

favourite

Share your favourite places with others built with MERN-stack

View Deployment · Report Bug

About the app

  • The main goal of this app is to help users to share their favourite places with others.
  • The app uses Google Maps API to get the loaction of places entered by users.
  • Google Maps API provides google maps which can be embedded in the website with target location and we can also extract the geo-coordinates of the location.

Design

  • It is possible that you may find the UI not that soothing.
  • It is made as minimal as possible with css only no external library used for styling it.

Built With 🛠

  • MongoDB
  • Express
  • React
  • Node

About MERN-Stack

MERN stands for MongoDB, Express, React, Node, after the four key technologies that make up the stack.

  • MongoDB - document database
  • Express(.js) - Node.js web framework
  • React(.js) - a client-side JavaScript framework
  • Node(.js) - the premier JavaScript web server

Express and Node make up the middle (application) tier. Express.js is a server-side web framework, and Node.js the popular and powerful JavaScript server platform. Regardless of which variant you choose, ME(RVA)N is the ideal approach to working with JavaScript and JSON, all the way through.

Setup

  1. Fork and clone the repository locally.
  2. Navigate to the cloned folder
  3. Download the latest version of Node.js for your OS
  4. Install yarn globally with the command
npm install yarn --global
  1. Starting the frontend client
cd frontend
yarn install
yarn start
  1. Inside backend folder create a new file named .env which will hold the environment variables image here
  • MONGO_URI -> the mongodb cloud database url.
  • JWT_SECRET_KEY -> the string secret used in creating the jwt tokens.
  • API_KEY -> Google maps api key
  1. Starting the backend server
cd backend
yarn install
yarn start

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" or "feature". Don't forget to give the project a star!

  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

Roadmap

  • Change image uploads from local to some cloud storage.

License

This application is released under MIT License for fair use (see License).

About

Share your favorite places with others.

https://treasure-places.netlify.app/

License:MIT License


Languages

Language:JavaScript 85.4%Language:CSS 13.2%Language:HTML 1.5%