Giter Club home page Giter Club logo

neptune-team's Introduction

infoMapp

Infomapp allows users to select a location on a map and receive information and trends analysis on the area.

Team

  • Ifi
  • Enkhtushig Namkhai
  • Donovon Jenson
  • Michael

Table of Contents

  1. Usage
  2. Requirements
  3. [Getting Started](#Getting Started)
  4. Development
    1. Installing Dependencies
  5. Roadmap
  6. [Style Guide](#Style Guide)
  7. Contributing

Usage

The app is made with a SERN stack and makes use of axios to handle requests.

Requirements

Make sure to have these installed on your computer:

  • Node
  • MySQL
  • Webpack

Getting Started

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

  1. Fork the repo from https://github.com/neptune-team/neptune-team
  2. Clone down your forked repo to your local machine
  3. Install the dependencies

Development

Installing Dependencies

Once you have forked the repo from https://github.com/neptune-team/neptune-team , install all the dependencies by running.

From within the root directory:

npm install

Getting the tokens for the API calls

We use Google Maps, Twitter, Walkable, and Indico API’s to collect the data, so you will need API keys for them to make requests.

Roadmap

View the project roadmap here

Style Guide

We are following the AirBnb style guide, which can be found here

Contributing

To contribute to this repo, see CONTRIBUTING.md for contribution guidelines.

neptune-team's People

Contributors

enkhtushignamkhai avatar mbntex avatar donovonjenson avatar ifidoesit avatar

Watchers

 avatar

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.