Giter VIP home page Giter VIP logo

p2-bikers-world's Introduction

A bike-sharing locator that help users to discover where are the bicycles located within the city. They can be located via these search fields stated below so that search results can be precised to what they need.

  • Country
  • City
  • State
  • Town

And, it comes with a mini forum for users to view incidents reported by other users around the globe. They are arranged in these categories,

  • Theft
  • Hazards
  • Crash
  • Infrastructure Issue
  • Chop Shop

UI/UX

User Stories: ---> (e.g. As a user type, I want to perform an action, so that I can achieve a goal.)

  1. As a commuter, I want to search for shared bicycles location, so that I know where to rent them while travel across the globe.
  2. As a commuter, I want to search for current location, so that I know where is my current location.
  3. As a commuter, I want to search for shared bicycles near me, so that I can rent them.
  4. As a commuter, I want to search for bicycle incidents report, so that I know the latest news around the neigborhood or country.
  5. As a commuter, I want to search for different types of bicycle incident reports, so that I can filter to the right information.

Features

In this section, you should go over the different parts of your project, and describe each in a sentence or so.

Existing Features

Users can ...

  • Feature #1 - View all the available bicycle locations around the globe when they clicked on "Locate Bikes" button.
  • Feature #2 - View current location within the map when they clicked on "Current Location" button.
  • Feature #3 - Search for another location within the map through the search field.
  • Feature #4 - Search for incident that matches the search query.
  • Feature #5 - View different types of incident when they search through the input field under "Incidents" section of the selected type on the dropdown within "Advanced Options" collapsible button.
  • Fetaure #6 - Search for a location on the map in the "Venue" section through the input field.

Future

  1. Locate the bicycles
    1. within a certain radius of searched location
    2. within a certain radius of current location

Features Left to Implement

Due to time constraints and challenges... Below here are the features I wished to implement.
  1. Locate the bicycles
    1. within a certain radius of searched location
    2. within a certain radius of current location

Technologies Used


Testing

These are the tests I have done so far...

Manual Test

  1. Index (index.html)
    1. Launch the html page by previewing it on a new tab of the browser, and ensure there isn't any occurrence of errors.
  2. App (app.js)
    1. Tested the script by viewing through the inspector's console. Make sure there is not any known errors.
    2. Tested with JSLint, apart from code format error, nothing critcal shows up.

Screen Test (Different screen sizes and browser)

  1. Screen
    1. 'div' element with 'map' id ... size changes when screen size is equivalent,
      1. (576px and below), map height will change to 400px
      2. (768px and below), map height will change to 300px
      3. (1024px and below), map height will change to 400px
      4. (1024px and below), map height will change to 600px

Deployment

  • The website is currently deployed on Github pages, and developed on AWS Cloud 9 IDE platform. Occasionally, I would perform some lightweight code edits using Microsoft Visual Studio Code.

Steps deployment

  1. Create a new repository for your project on your local computer.

    git init .                  // initialize repo with all files
    git add .                   // add all files into local staging
    git status                  // check if any files are left out before commiting
    git commit -m "message"     // commit change with message of your files into repo
    
  2. Add your remote git link for uploading your files onto Github later on.

    git remote add origin <your-remote-git-link>    // add your remote repo link
    
  3. Push your files onto your remote

    git push -u origin master   // upload your files into your remote repo
    
  4. Should you have the interest to work the files offline, you can do so by cloning a copy.

    git clone <remote-link>     // Clone the selected repo offline
    

NOTE: All commits are pushed to master branch, as currently there is no intention of creating new branches.

Credits

Content

  • All contents on the website were written by me.

Media

  • Mountain bike icon for the navbar, taken from flaticon

Acknowledgements

This is for educational use.

p2-bikers-world's People

Contributors

naturaldev0 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.