Giter VIP home page Giter VIP logo

andela-sendit's Introduction

Andela-SendIT

SendIT is a courier service that helps users deliver parcels to different destinations. SendIT provides courier quotes based on weight categories.

Motivation

This project was given as a learning project for andela kigali bootcamp preparation, it help us to demonstrate our technical abilities by building a full-stack application.

Build status

Build status of continus integration i.e. travis, appveyor etc. Ex. -

Coming soon

Code style

We will be using Airbnb code style for javascript

Screenshots

Coming soon

Tech/framework used

Built with

  • HTML+ CSS
  • Vanilla Javascript ES6
  • NodeJs/ Express

Features

Here are Required Features:

  1. Users can create an account and log in.

  2. Users can create a parcel delivery order.

  3. Users can change the destination of a parcel delivery order.

  4. Users can cancel a parcel delivery order.

  5. Users can see the details of a delivery order.

  6. Admin can change the status and present location of a parcel delivery order.

Optional Features are :

  1. The application should display a Google Map with Markers showing the pickup location and the destination .

  2. The application should display computed travel distance and journey duration between the pickup location and the destination. Leverage Google Maps Distance Matrix Service.

  3. The user gets real-time email notification when Admin changes the status of their parcel.

  4. The user gets real-time email notification when Admin changes the present location of their parcel.

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Coming soon

Installation

Provide step by step series of examples and explanations about how to get a development env running.

Coming soon

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Coming soon

Tests

Describe and show how to run the tests with code examples.

Coming soon

How to use?

If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.

Coming soon

Contribute

Let people know how they can contribute into your project. A contributing guideline will be a big plus.

Coming soon

Credits

Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project.

This Guide for the readme style

Coming soon

Anything else that seems useful

License

A short snippet describing the license (MIT, Apache etc)

MIT © espoirMur

andela-sendit's People

Contributors

espoirmur avatar

Watchers

James Cloos 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.