An app for trading books.
- Book Trading App
- Table of contents
- Prerequisites
- Starting the App
- Salient Features
- Built With
- Contributing
- Author
- License
- Acknowledgments
- TODOs
Make sure you have the following installed.
- Node (version, >= 7)
- MongoDB (version, >= 3)
Follow below steps to start the app locally for the first time.
- clone this repo
- cd into the
BookTradingAppdirectory - Run -
npm ito install depencies - Run -
cp sample.env .env - Fill the .env file with appropriate values
- Run -
mkdir datato create a db directory - Run -
mongod --dbpath ./data > /dev/null &to start mongo server - Run -
npm fillto fill the database with seed values - Run -
npm startto start the server
[Note]:- You need to follow the above steps first time only. From next time onwards start the server by running npm start.
This app helps send/receive/manage trade requests for books.
User can view all the books available, i.e. books owned by all the users can be viewed.
User can add a book to the app. Adding a book in the app means that the user is indicating they possess the book.
The app has a built in search system, which helps a user search for a book and add it.
The search API uses the Google Books API on the backend, which ensures the correct ISBN number is retreived which helps identify a book accurately.
User can read the summary of the book before deciding whether that book is the one they wish to add.
User can add mutiple books at the same time.
User can have multiple copies of the same book.
This is the core feature of this app, i.e, users can exchange books.
When a user opens a trade request for a book, the user may decide to give or not give any book in exchange.
If a user decides not to give a book in exchange, the real life parallel is like asking for a book from someone.
If a user asks for a book and wants to give their book in return then this is like actually exchanging a book in real life scenario.
Both the above options are possible using this app.
There are basically two ways to open trade requests.
User can select someone else's book while viewing the book list in the gallery.
This opens a window showing details of the book (summary, added by, etc). This window also contains a trade action button. When the trade button is clicked, a dropdown emerges asking to confirm the trade request. In addition to that there is optional section where user can add a book they would like to give in exchange.
[Note]:- The exchange book section is optional here.
If request is made without using it, then this is Category #1 no exchange request
If a user selects their own book from the optional section, then this is Category #2 with exchange request
User can select their own book in My Books section.
This opens a window which again has the trade button.
When it is selected again a dropdown is shown asking to confirm the request.
But this time there is mandatory section showing books belonging to all other people and asking to select.
This should be obvious because making a Trade Request just by selecting one's own book makes no sense.
User must select someone else's book and submit request.
This will be the Category #2 with exchange request
As should be obvious by now there are two kinds of Trade Request.
User can open Trade Requests By Me section to see a list of requests opened by them.
They can see the book they asked for and the book they wanted to give in exchange (if they did want to give a book in exhange, remember this is optional).
The only action a user can perform in this situation is close the Trade Request.
User can open Trade Requests For Me section to see a list of requests opened by other users asking for books they own.
They can see the book the other user asked for and the book the other user wanted to give in exchange (if at all, this is optional).
User can perform two options here
- Reject Trade Request - If user selects reject, the
requester(the one who opened the request) is informed. - Accept Trade Request - If this is selected, books are exchanged. Other additional actions also take place. See below.
If a user accepts a Trade Request for a particular book. It makes sense that he is implicitly rejecting other Trade Requests for the same book.
Hence these are the steps which the system performs when a user accepts a Trade Request.
-
All pending requests by other users asking for the same book is automatically
rejected. (If you have accepted the trade request of one person for a book, it automatically means you have rejected other requests for the same book.) -
All pending requests by the user in which this particular book was supposed to be given away as exchange book are
closed. (If you have accepted the trade request of one person for a book, it means you will no longer possess the book. And so you cannot tell anyone that you want to give this book in exchange.)
- Node - JS Runtime Environment
- Npm - Package Manager
- Express - Web Framework
- MongoDB - Database
- Mongoose - Database ORM
- Vue - Frontend Library
- Vuex - State Management Tool
- Webpack - Frontend Bundler
- Mocha - Testing Framework
- Git - Version Control
- VS Code - Code Editor
- Heroku - Hosting and Continuous Deployment
- Chrome - Browser
Contributions are welcome. Please keep an eye on the Project's issue tracker and if you think you can handle an issue, please comment on the issue page.
- ChinguCentral Community
- Family and Friends
- Improve UI, particularly trade modal dropdown.
- Add linting to webpack