Giter Club home page Giter Club logo

sharity's Introduction

Logo


Welcome To Sharity

Sharity is an Online, Donor to Charity, Web Application that allows for individuals to sign up and donate their unwanted items for Charities to then claim. Our team of Full Stack Software Engineers were approached by a client who asked us to build the Sharity web application. We were given feedback throughout and a little over a week to develop and deploy the application.

Below you will find our User Stories, Dev Team, Tech Stack, Installation Guidance, and Wire Frames.

This Application was built by a team of 8 Full Stack Software Engineers from the Hack Reactor, Austin, 49th Cohort. (HRATX49)


VIDEO DEMO


User Stories

  • As a Donor/Charity, I want to be able to Create an Account
  • As a Donor, I want to be able to put an Item up for donation
  • As a Charity, I want to be able to claim an Item that was put up for donation
  • As a Donor, I want to be able to delete an Item that was put up for donation
  • As a Charity, I want to be able to sort through unclaimed donations based on Name, Location, Date, & Category
  • As a Charity, I want to be able to generate a statement of my Donations
  • As a Donor, I want to be able to generate a statement for tax purposes
  • As a Donor, I want to see all of my claimed, but not yet picked up donations
  • As a Donor, I want to see a history of all of my donations
  • As a Donor/Charity, I want to be able to establish communication with my counter part
  • As a Donor, I want to see the total value of items I have donated
  • As a Charity, I want to be able to confirm when a donation was picked up
  • As a Charity, I want to be able to see the total amount and value of items claimed

Yet to Come

  • As a Donor/Charity, I want to be able to chat on the site
  • As a Donor, I want to be able to claim a donation
  • As a Donor, I want to be able to confirm a donation was picked up
  • As a Donor, I want to be able to select whether or not an individual can claim my donation

The Dev Team


Tech Stack

Sharity uses a number of open source projects to work properly:

Front End
  • React - A JavaScript library for building user interfaces
  • React Router - Declarative Routing for React
Back End
  • node.js - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Express - fast node.js network app framework
  • MongoDB - A noSQL database for modern apps. Easily organize, use, and enrich data โ€” in real time, anywhere
Testing And Deployment
  • AWS - Amazon Web Services offers reliable, scalable, and inexpensive cloud computing services.
  • Google Cloud - Meet your business challenges head on with cloud computing services from Google.
Developer Tools
  • WebPack - Webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser.
  • Babel - The compiler for next generation JavaScript
  • NPM - An all in one package manager.
API
  • Axios - Promise based HTTP client for the browser and node.js

Installation

Install the dependencies and devDependencies and start the server.

$ cd HRATX49-Sharity
$ npm run setup
$ npm run start
Go to localhost:5000/

Wire Frames

Landing Page Charity Page User Page Login & SignUp Modal Items Details

sharity's People

Contributors

a-casper avatar polancichben avatar deneelopez avatar jonathanzurita avatar kperre94 avatar cmurray1105 avatar richigro avatar scottkelder avatar kptkrunch avatar zubaird avatar dependabot[bot] avatar seancmeyer 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.