Skip to content

AdvaithNair/Forrest

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Forrest

Forrest is an application intended to help users plot fast and environmentally friendly drive routes and track their environmental savings. These routes include energy and CO2 saving paths. Forrest uses the Google Maps API and Google Directions API to generate the most efficient routes for users. Finally, Forrest acts as a bridge to becoming a social media, with the capabilities to extend its own features to become a utility-social-media hybrid application.

NOTE: If you spot a bug, please contact me at [email protected]/[email protected] or Dom at [email protected].

Forrest contains the following features:

  • Testing Ping Route
  • Auth Functions
    • Sign Up
    • Sign In
    • Log Out
    • Three levels of Authorization(User, Admin, Owner)
  • Common Folder with constants, objects, types, and secrets
  • MaterialUI
  • Google Maps Interface
  • Google Directions API
  • Responsive Design
  • Search for Users

Technology Overview

It utilizes the following technologies:

  • Client
    • ReactJS
    • Material UI
    • Axios
  • Server
    • NodeJS
    • ExpressJS
    • PostgreSQL
    • TypeORM
    • JSON Web Token
    • BcryptJS
  • APIs
    • Google Maps
    • Google Directions

All code is constructed using TypeScript.

Prerequisites

Technologies Used

Commands

Execute these commands to ensure Forrest can run properly. Run these in the root directory.

Install Packages

yarn install

Web

yarn web

Server

yarn server

Common

yarn common

OR

cd common && tsc

NOTE: You probably want to run web, server, and common in three seperate terminals. They use hot reloading.

Contributors

  • Advaith Nair

  • Dominic Hupp

Contact

For questions, feel free to contact me at [email protected]/[email protected] or Dom at [email protected].

About

Environmentally Friendly Driving

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.5%
  • CSS 2.0%
  • HTML 0.5%