Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajdip019/booklee
Booklee is a Web App, to sell and donate your second hand books at a minimal price or free of cost to help a needy learner, learn and grow more. This made it to the Finals of Microsoft Imagine Cup 2022
https://github.com/rajdip019/booklee
azure cognitive-services cosmosdb geocoding geolocation mapbox mapbox-gl-js next-auth nextjs react sengrid ssr tailwind tailwindcss twillio vercel
Last synced: 2 months ago
JSON representation
Booklee is a Web App, to sell and donate your second hand books at a minimal price or free of cost to help a needy learner, learn and grow more. This made it to the Finals of Microsoft Imagine Cup 2022
- Host: GitHub
- URL: https://github.com/rajdip019/booklee
- Owner: Rajdip019
- License: mit
- Created: 2022-01-09T11:07:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-06T18:46:05.000Z (about 2 years ago)
- Last Synced: 2024-10-11T12:11:37.456Z (3 months ago)
- Topics: azure, cognitive-services, cosmosdb, geocoding, geolocation, mapbox, mapbox-gl-js, next-auth, nextjs, react, sengrid, ssr, tailwind, tailwindcss, twillio, vercel
- Language: JavaScript
- Homepage: https://booklee.vercel.app/
- Size: 1.73 MB
- Stars: 20
- Watchers: 2
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 0. Developer? Want to contribute?
If you want to contribute to Booklee then please click here. [Setup Guide in Local System](https://github.com/Rajdip019/booklee/blob/main/local_env_setup_guide.md)
But, before anything, We will highly suggest you to read what is Booklee. And what functionalities we have. And visit [Booklee](https://booklee.vercel.app/), and experience the web app once.
# 1. What is Booklee ?
Booklee is a Web App, to sell and donate your second hand books at a minimal price or free of cost to help a needy learner, learn and grow more.
You can visit **_Booklee_** at [Booklee](https://booklee.vercel.app/)
We have also added a **video guide**, on how to use Booklee [here](https://www.youtube.com/watch?v=ykNmo_W762E)
# 2. All Features Available
When you land on the site, you'll see a lot of amazing features, ranging from the ability to login/sign-up , search for your favourite books, etc.
Let's go through them, one by one.
## a. Sign-in / Sign-up
Here you can SignIn to our webiste or just Continue without Singing in. Even if you decide not to sign in, you can still continue and browse our awesome collection of books on the website.
The website has sections like :
- Recently Added
- Free Educational Books
- Top Story Books
Click on the "View All" button, on any section to view _all_ the books in that section
## b. Searching
You also have the option of searching and filtering your search results according to (Category, Price, Condition & Location).
This way you'll be able to find the correct book for you as fast as possible.
## c. Product Details
Click on any book, and you'll land on the product details page. Here, You'll see all the important and relevant details related to the book.
```diff
You need to be signed in to view all the seller details.
```
You can also see this Interactive Map, indicating the Location of the Book.
# 3. Profile
## a. Donator / Seller Profile
You can visit the Profile of any of the Sellers and Donators on Booklee. You'll find all of books listed there. The books have also been filtered by the categories mentioned above.
You can also see the books that have already been sold/donated by them in teh past.
## b. Signing In
You'll be missing out on a lot if you're not signed in to the site. For example, you can't
- Send a direct mail to the Seller/Donator enquiring about any book.
- Can't list any of your own books for selling/donating.
- Can't Donate Books directly to an NGO.
##
So, you chosen to sign in. Great!
We offer you 3 easy options. You can choose to login from any of these accounts
- Google
- Twitter
- Github
```diff
Don't worry. We don't steal your data.
We only require a username, email ID, and a profile photo.
```
This is what your homepage will now look like :-
## Profle: Admin and Visitor
Now, in the Profile Section, you can control a lot of things. For example
- Managing the book that you've listed.
- Get the 'Invoice' or 'Donation Proof' of all the books that you've donated/sold.
- List books for selling/donating.
- Edit your personal details (except email id đź“«)
```diff
In Profile, there's also an Admin View and Visitor View Option. Using this, you can preview what your profile will look like to other visitors.
```
# 4. Listing Books You want to Sell / Donate
If you're already signed-in. You have the option to sell or donate your books using Booklee.
Just click on the 'Sell' or 'Donate' buttons on the Navbar from your homepage, or your profile page.
## a. Selling a Book
Just fill out the form, and click on SUBMIT to List your Book.
## b. Donating a Book
Same as sell. Just fill out the form, and click on SUBMIT to List your Book.
## c. Admin Panel
Now, after you've listed your book. You can also edit it.
Just go to your Profile Page, and Click on 'Manage Book'.
You'll be directed to a page with the project details, and a Magical Admin Panel. Here, you can
- Edit the Book Details.
- Mark it as Sold, and generate an Invoice / Donation Proof
- Delete the Listed Book.
- See the Book Details in 'Visitor View'
## d. Marking a Book as Sold
If you are marking a book as sold, you need to follow the following steps :-
1. Ask the Buyer/Donee to tell their email adress, which is registerd in Booklee and enter that in.
2. Once the system checks the user is register or not, you will see a message according to that. If the User is not authenticated then you will see aa error message to Pop up as invalid User.
3. Or if the user is verified the system will pull the user data and show it on the modal with a verified mark!
4. Now the Seller/Doner must click on “Get OTP” and ask the buyer/donee to tell the OTP Sent to their Email to get Verified and get a Invoice/Donation Proof.
5. After entering the OTP click on Make Invoice to Make a invoice which the seller/Donator can get from his Profile in the Sold/Donated Section.
6. And the Buyer/Donee will get the Invoice/Donation proof in Booklee Website in Your Orders Section. (*after sigining in with his email).
# 5. Favorites Section
You can mark a book as your favourite book simply by clicking on the love icon on each card and can find them later in the Favorite Section.
# 6. Your Orders Section
You can find all of the Books you bought or got donated in the orders section.
From here you can get the invoice/donation proof by clicking on the “Get Invoice” and “Get Donation Proof” buttons respectively.
# 7. Invoice/Donation Proof
On the invoice/Donation Proof Page you can save or print the Invoice/Donation Proof Directly from the Page.
# 8. Message
If you want to contact a seller regarding a doubt about the book, you can also do it here.
You just have to enter the name of the book you have query about and write the query and the seller will receive an email about your query and can reply you back.
# 9. Donate to NGO
If you decide to donate your old books to an NGO, you can click on “Donate To NGO” Button on the home Page or click on the Donate button on the Navbar and navigate to Donate to NGO then.
Once you Click on Donate to NGO button, you will land on a Page where you can see the Total Books donated to NGO which is directly coming from the Azure Cosmos DB database.
Now on Clicking the Donate button you will be redirected to a form.
Now After filling the form when you click on Submit, the System will find the Top 10 nearby NGO and will show the list with a interactive map which will point out the exact location of the NGO’s on the Map.
Now after you choose your preffered NGO to donate book and click on Donate we will receive your info, The NGO, and the Book Details you want to Donate to the NGO.
Then, we will contact the NGO accordingly.
```diff
These are almost all the Features of the Website. There are still some features in the Website Which is pretty self explainatory so it’s not included here.
```