Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
katemat committed Jul 15, 2020
1 parent d15cfe8 commit fc7aaa3
Showing 1 changed file with 26 additions and 39 deletions.
65 changes: 26 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,41 @@
# Trashure App, v. 1.0.0
## Team Project

### [Try it now](https://heroku.... need to update)
Trashure App, v. 1.0.0

### Overview
Team Project

🏘 Are you moving out soon?
🚚 Still have some stuff you love but not able to take with you?
🎫 Have spare tickets fot tonight?
Give it to someone for free! Share your Trashure!
[Try it now](https://trashure.herokuapp.com/)

---
### Featutes
Overview

* User can see on the map 🌏 any Trashure Items available in nearby area (user-geolocation feature is implemented)
* User can sign up and login
* Registered User can Reserve any available item
* Registered User can Post Items
* Registered User can see a list of Items (posted and reserved)
🏘 Are you moving out soon? 🚚 Still have some stuff you love but not able to take with you? 🎫 Have spare tickets fot tonight? Give it to someone for free! Share your Trashure!

---
Features

- User can see on the map 🌏 any Trashure Items available in nearby area (user-geolocation feature is implemented)
- User can sign up and login
- Registered User can Reserve any available item
- Registered User can Post Items
- Registered User can see a list of Items (posted and reserved)

### Technical Requirements

🛠 To build the App the following technologies and tools were used:

- HTML, CSS, JavaScript
- PostgreSQL
- Node.js
- Express
- middleware: pg, bcrypt, passport, express-session, method-overide, ejs
- Heroku for deployment
- version control system: Git
- Whimsical for creating storyboards
- Trello for keeping track of development

---
## Trashure DB - ERD

![ERD](/public/images/TrashureERD.jpg "Trashure ERD")
- HTML, CSS, JavaScript
- PostgreSQL
- Node.js
- Express
- middleware: pg, bcrypt, passport, express-session, method-overide, ejs
- Heroku for deployment
- version control system: Git
- Whimsical for creating storyboards
- Trello for keeping track of development

---

## Challenges and next release Features
### Challenges and next release Features

One of the main challenges the Team faced with the project is being able to obtain information from a 3d party API, manipulatianig with geodata, storing these data in DB

For Future releases some extra features can be added:

- Search option so User can sort all available in DB items by certain criteria
- Email notifications with details of reservation can be sent to the User who posted the Item and to the User who reserved the Item
- Integrate third party API to improve UX uploading images (e.g. use Cloudinary)
### For Future releases some extra features can be added:

- Search option so User can sort all available in DB items by certain criteria
- Email notifications with details of reservation can be sent to the User who posted the Item and to the User who reserved the Item
- Integrate third party API to improve UX uploading images (e.g. use Cloudinary)

0 comments on commit fc7aaa3

Please sign in to comment.