WanderBuddy

WanderBuddy is a traveling tool aimed to help tourists share their adventures.
Explore the docs »

View Demo · Report Bug · Request Feature

(back to top)

(back to top)

To get a local copy up and running follow these simple example steps.

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

• Verify that pip is installed

  pip --version

• Verify that supabase is installed

  supabase --version

  You may refer to this link for instructions to install supabase

1. Get a Bot Token from Telegram's @BotFather. You may follow the instructions here "Obtaining your Bot Token"

2. Clone the repo

   git clone https://github.com/5NT-1/WanderBuddy.git

3. Install pip dependencies

   cd WanderBuddy
   pip install -r requirements.txt

4. Make a local copy of environment variables

   cp .env.example .env
   cp .env.local.example .env.local

5. Enter your BOT TOKEN, Supabase credentials in .env and .env.local

   BOT_TOKEN=<BOT_TOKEN_HERE>
   ...

   You will also need the FRONTEND_URL if you're hosting a frontend

6. Start up a local database

   supabase start

7. Start up the frontend server

   cd supabase-react && npm run dev

8. Start up the telegram-bot

   python main.py

(back to top)

For more examples, please refer to the Documentation

1. Start a new chat with your Telegram Bot with /start.
2. The Bot will prompt you to start a new Trip!
3. After adding the name of the trip, the Bot will prompt you to create a new route.
4. Once the route has been created, you can now start tracking your adventures!

• You can send a location to mark a new checkpoint in your journey
• You can send an image to store your memories at the current location
• Whenever you're ready to move on, you can use the /next and /prev

5. After you're done with your journey, feel free to share it with your friends!

• Use the /share_trip [friend's telegram username] to share.
• Your friend can use the /follow command to import it into their own collection!

(back to top)

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

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

(back to top)

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)

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

(back to top)

Project Link: https://github.com/5NT-1/WanderBuddy

(back to top)

• Devpost We would like to thank NUS Students' Computing Club, and the organising committee for organising LifeHack'2023
• Standard Chartered for sponsoring the Hackathon
• Other distinguished sponsors for sponsoring the Hackathon

(back to top)