Skip to content

tomkkl/OptiRoute

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

new

optiroute

optiroute is a web application designed to streamline the process of event scheduling and route planning, while also offering social interaction features.

Features

  • User Authentication: Sign-up, login, and password reset functionalities.
  • Event Management: Add, view, and manage personal and shared events on a calendar UI.
  • Route Planning: Integrated with Google Maps, allowing users to plan routes, select travel modes, and manage saved routes.
  • Weather Widget: Integrated with OpenWeather, allowing users to see the weather around the location of their routes.
  • Social Interactions: Connect with friends, share events, and manage friend requests.
  • Notifications: Customize notification settings and receive email/text notifications for any upcoming events.

Tech Stack

  • Frontend: React.js
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Others: Google Maps API, OpenWeather API

Getting Started

  1. Clone the git repository
  2. Change directory into optiroute and run npm --force install
  3. Change directory into optiroute/src/backend and run npm install
  4. Inside optiroute/src/backend, create a new file, .env and paste these contents in:
// You will have to grab your own MongoDB URI.
PORT=4000
MONGO_URI=mongodb+srv://user:password@mycluster.vsmdces.mongodb.net/?retryWrites=true&w=majority
  1. Run npm start in optiroute and run npm run dev in optiroute/src/backend

Required API Keys

You will be required to acquire API keys to fully utilize all features of optiroute.

  • SMS Notification - textflow.me
    • Replace apiKey in optiroute/src/App.js with your key
    • Replace apiKey in optiroute/src/Components/NotificationSetting/NotificationSetting.jsx with your key
  • Google OAuth
    • Replace client_id in `optiroute/src/Components/LoginSignup/LoginSignup.jsx with your key
  • Google Maps API
    • Replace apiKey in optiroute/src/Components/MapV2/GMapV2.jsx with your key

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •