Skip to content

NandaMonroe/Traveledge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation


banner

A place to compare and discover your next destination!


View Demo · Report Bug · Request Feature

📒 Table of Contents

  1. About The Project
  2. Getting Started
  3. Enviroment Variables
  4. Roadmap
  5. Contributing
  6. License

🔰 About The Project

You know when you want to go somewhere new but there are so many things to consider before define the place, e.g, weather, culinary, safety, budget, nature, kids friendly, etc. So much avaliate, many tabs open, lots of time wasted and indecision. This website came to include all in one and make things easier for the user. You can compare and check other people's opinion about it before making a decision. A very friendly and intuitive to use. Open and discover. See you on the other side!

(back to top)

🔌 Built With


MongoDB Express Vite Node.js MaterialUI

(back to top)

⚡ Getting Started

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/NandaMonroe/Traveledge

# Go into the repository
$ cd traveledge

# Install dependencies
$ npm install

# Run the app
$ npm run dev

Note If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

(back to top)

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT=8000
DB=(databasename)
# mongo atlas connection
ATLAS_USERNAME=(yourusername)
ATLAS_PASSWORD=(yourpassword)

(back to top)

🌵 Roadmap

  • UI for place page
  • Functionality for filters
    • Ratio Buttons
    • Rating
    • Budget

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

(back to top)

🔒 License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Releases

No releases published

Packages

No packages published