Git Product home page Git Product logo

mybooletin's Introduction

Freebees

Have something to give away? Here's Freebees.

Freebees

Introduction

This web application allows a user to post items that she/he wants to give away. Other users can see the posted items and their locations.

Getting Started

We used bower and npm to install dependencies. Nodemon runs the server, and Mongod runs the local database. The bower dependencies are downloaded to a node_modules folder, which is pre-specified in the .bowerrc file. Before running locally, run the following code in the command line.

bower install
npm install
mongod
nodemon index.js

Note: To use mongod, you must set the database path. You can do so with the following command.

mongod --dbpath <path>

File Structure

Files are organized in the following directories: Client and Server.

Choice of Technologies

For this project, we used AngularJS for our front end and Node.js, Express, and MongoDB for our server and database.

We used MongoDB for the document storage of the item names and the item locations. We used an ORM called mongoose, which is an npm module, which gives us easier access to our database. Refer to this link to learn more about mongoose Mongoose Doc. We used MongoLab as a heroku addon when delpoying our app.

Google Maps API

We used Google Maps JavaScript API for our locations.Google Maps JavaScript API

Features

  • Users can add one item at a time with its physical address as location.
  • Users can remove an item from the map when it becomes unavailable.
  • Users can use their location based on IP address.
  • Users can search the database by item name.

In progress

  • Filter based on when item was submitted.
  • Users can upload pictures along with their posting.

Git Workflow

Please refer to the CONTRIBUTING.md file to see our git workflow.

Style Guide

Please refer to the STYLE-GUIDE.md file to see our style guide.

Contributors

MKS Greenfield Project

mybooletin's People

Contributors

alicekao avatar aneylon avatar collinadams avatar danielnovograd avatar darko7 avatar eternal44 avatar jpark2973 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

mybooletin's Issues

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.