/pet-finder-1

Pet finder web application

Primary LanguageJavaScript


Logo

Pet-Finder Application

About The Project

Product Name Screen Shot

Pet owners do not have a stand-alone system in place to track down lost pets in the city of Calgary. Pet-Finder is a mobile friendly application where its users can share details regarding lost pets such as last location and pet attributes. The broad community of users can help find the lost pet by offering to share known strategies, advice or even the good news if they've found the pet nearby or in some other location!

Built With

  • Node
  • React
  • Mongo
  • MaterialUI
  • Express

Getting Started

Prerequisites

  • get npm
    npm install npm@latest -g
  • Download Node.js from https://nodejs.org/en/
  • Install Express.js
    $ npm init 
    $ npm install express
  • Install NPM packages
    npm install

Installation and Run

  1. Clone this repo
    git clone https://github.com/nkouki98/SENG-513.git
  2. Install react-scripts and dotenv
    # install locally (recommended)
    npm install dotenv --save 
    npm install react-scripts
  3. Navigate to folder "backend" and run in terminal
    node server.js
  4. Open another terminal, navigate to folder "petfinder" and run
    npm start
  5. Web application runs as follows
    React localhost:3000 
    server port:4000 

Collaborators

  • Amman Yusuf
  • Owen Hunter
  • Mustafa Muhammed
  • Matthew Jarrams
  • Syed Farhan Ahmed

Future Work

  • Google API

Acknowledgments

(back to top)

Reference for this template

https://github.com/othneildrew/Best-README-Template/pull/73