Travel Helper

An awesome Website to help you while travelling.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Travel Helper is a website for travel bloggers and travelers, who have the same passion of traveling and enjoying to share their journeys and memorable experiences. Here you can pin point all about your travel experiences, interesting attractions, accommodation reviews, food reviews and more of untold stories.

Features

• Save locations you want to visit.
• Append reviews for each and every place you visit.
• Create memories by pin pointing the places.

Build With

• Workflow and Architecture Design
  • Excalidraw
• Prototyping and Frontend Design
  • Figma
• Frontend
  • React JS
  • HTML
  • JAVA SCRIPT
  • BOOTSTRAP
  • CSS
• Backend
  • Node.js (Express.js)
  • MongoDB Atlas
• Middleware
  • JSON WEB TOKEN

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/priyanshpsalian/QR-Code-Generator.git

2. Install NPM packages

   npm i

Local Setup || Project Structure

NOTE: Individual instructions can be found in respective directories.

• The project contains 4 broad directories.

*
├───client
└───server

• client: The frontend for the application.
• server: The backend for the application.

Client

For local setup of frontend:

• cd frontend
• npm i
• npm start
• Go to localhost:3000

Structure

src
├───components
└───index.js

Individual Component & Container Structure

component
├───component.jsx
└───component.css

Server

For local setup of backend:

• cd backend
• npm i
• npm start

server
├───controllers
├───models
├───routes
└───package.json

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Issues

See the open issues for a full list of proposed features (and known issues).

(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

License

Copyright © 2022 Priyansh Salian

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contact

Priyansh Salian - @my_twitter

Email - @my_email

Project Link: https://github.com/priyanshpsalian/Travel-Helper