Have something to give away? Here's Freebees.
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.
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>
Files are organized in the following directories: Client and Server.
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.
We used Google Maps JavaScript API for our locations.Google Maps JavaScript API
- 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.
- Filter based on when item was submitted.
- Users can upload pictures along with their posting.
Please refer to the CONTRIBUTING.md file to see our git workflow.
Please refer to the STYLE-GUIDE.md file to see our style guide.
- Collin Adams (Collin Adams)
- Alice Kao (Alice Kao)
- Jessica Park (Jessica Park)
- Michael Serna (Michael Serna)
MKS Greenfield Project