Welcome To Traverse 👋

🔗 Try it out here .

• Production Server

🏄🏼‍♀️ Plan your next trip with us 👇

👨🏼‍💻 Tech Stack

Client: React, Arco Design, MapBox GL

Server: Appwrite

Other: OpenAI, Chart.Js

Appwrite Services Used

• Auth
• Database
• Storage bucket
• Serverless cloud functions

Run Locally

Clone the project

 git clone https://github.com/Traverse-A-Travel-Planner/traverse-client

Go to the project directory

  cd traverse-client

If you want to configure your own server for traverse follow these steps. To use our server configurtion skip this section.

Configure Your Own Appwrite Server

• Create appwrite account.
• Get your API keys from dashboard.
• Now, open folder auto-setup.
• Create a .env file in this folder. See .env.example for reference.
• Put the Appwrite api key, endpoint and project id in .env file.
• Now, open terminal in root of traverse-client project.
• Run: npm run setup-server. This will setup all the resources for traverse in your freshly made project.
• Login to Appwrite with appwrite-cli.
• Run: appwrite deploy function --all . This will deploy the serverless functions in the appwrite cloud.

An overview to our database architecture:

Collection Name	Collection Id
places	places
reviews	reviews
favourites	favourites
sharedTrips	sharedTrips

Attributes and Indexes of places collection

Attributes and Indexes of reviews collections

Attributes and Indexes of favourites collection

Attributes and Indexes of sharedTrips collection

• Above steps were for configuring traverse in your own server.

Run the client application

• Put the necessary configurations like project id and server endpoint in src/Services/config.js if you are using your own server. If you are using our server configuration, leave it as it is.

Install dependencies

  npm install

Start the server

  npm  start

Local URL

• Navigate to http://localhost:3000

Authors

• Yaman Sarabariya
• Bibek Shah
• Sandip Khadka

License

MIT

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.