Giter Club home page Giter Club logo

car-mate's Introduction

CarMate ๐Ÿš—

CarMate is a full-stack app where individuals can keep track of their vehicle's maintenance and preventative measures. Keeping track of your vehicle's maintenance will help you extend the life of your vehicle. Users can check which services are available on the landing page, then log in to their account to view and save their vehicle's service details. Data is obtained from CarMD and saved into a MongoDB database.

Motivation

We wanted to build an app that would help a wide variety of users and came to the conclusion that car maintenance was ubiquitous. Our idea was to create an app in which users can receive and keep track of their car maintenance as it's something that people easily lose track of until it's too late.

Screenshot

Tech Stack

This application was built using:

  • MongoDB
  • Express.js
  • React.js
  • Node.js

Other Tech

Included in the application's dependencies are:

  • Mongoose.js for modeling the saved data
  • Passport.js using Google OAuth

Getting Started

The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installation

$ git clone https://github.com/harpalassi/car-mate.git
$ npm i

Setup .env file

Make sure you generate the following API keys from the appropriate website:

  • CarMD API
  • Google+ API for Google OAuth
  • MongoDB user credentials*

Once you have all the keys generated, create a new file in ./.env folder, and include the keys as follows:

REACT_APP_CARMD_AUTH_KEY=insertCarMDAuthKey
REACT_APP_CARMD_PARTNER_TOKEN=insertCarMDPartnerToken

GOOGLE_PLACES_API_KEY=insertGooglePlacesAPIKey

GOOGLE_USER_CLIENTID=insertGoogleUserClientID
GOOGLE_USER_CLIENTSECRET=insertGoogleUserClientSecret
MONGODB_URI=insertMongoDBURI
SESSION_COOKIE_ENCRYPT=insertSessionCookieEncrypt

Running Application

Once the application dependencies are installed, and the .env file has been configured, run the application using the command:

npm start

Team

  • Ian Bunn
  • Harpal Assi
  • Rebeca Dodero
  • Nic May

๐Ÿš€ Deployed at: https://carmateinfo.herokuapp.com

car-mate's People

Contributors

harpality avatar ianbunn avatar nic4455 avatar rebecalvarez avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

moussariad

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.