Git Product home page Git Product logo

website's Introduction

Online E-Commerce Store for Selling & Purchasing Used Books. Specially for Competitive Exams.

  • It Is a Student Oriented Platform.
  • Bookshlf Pickups Books from Partnered Seller and sells to the buyer in any corner of India.
  • Under Bookshlf Partnership Program the Partner is eligible for upto 60% of the profit earned by selling thier books.

Index

# Title
1 Built
2 Requirements
3 Setup Locally
4 Contribute Contributing Contributers
5 API Keys
6 Sample Screens Visit Store

Built With

Requirements

You will need node and npm installed globally on your machine.

  • Open terminal, write the following command and press enter.
$ npm -v

The terminal should return your npm version.

How to set up your local environment

1. Clone App

  • Make a new folder and open the terminal there.
  • Write the following command and press enter.
  $ git clone https://github.com/Bookshlf-in/Website.git

2. Install node packages

  • Move inside the cloned folder.
  • Write the following command and press enter to download all required node modules.
$ npm install

or

$ npm i

3. Run Locally

  • While you are still inside the cloned folder, write the following command to run the website locally.
  $ npm run start or npm start

Contributing

Love the project and want to get involved? You’re in the right place!

How to Contribute

To start contributing, follow the below guidelines:

1. Fork this repository.

2. Follow the Environment setup above.

3. Checkout into the dev branch. Create a branch from the dev branch with git checkout -b branchname where the name is something descriptive about the issue your branch will fix.

 $ git checkout -b <branch_name>

4. Make your changes, and test them to make sure they work.

5. Add and commit your changes

 $ git add . && git commit -m "<your_message>"

6. Push Code to Github under your branch

 $ git push origin <your_branch_name>

7. When you're ready to submit your pull request, merge the latest version of dev, to make sure your branch is up to date:

git checkout dev
git pull origin dev
git checkout <your_branch_name>
git merge dev

8. Resolve any merge conflicts if they exist, test to make sure your feature branch still works correctly, and then git push origin <your_branch_name>

9. On Github, create a pull request from your feature branch. Always make the PR against the dev branch! Make sure to summarize your changes you made, and if there's anything specific you want reviewed or tested, note that in the PR.

10. When approved, your branch will be merged into master and you're done! Thanks for contributing! :)

Contributors

Made with contributors-img.

Don't forget to ⭐ this repository !!

API KEYS

  • This is a Neccessary Step to make APIs Work.

To Make API Requests Possible, Follow below Steps after Locally Setting Up Project.

  • Create a File Named .env into Main Repository Folder eg : ...\Website\.env.
  • See Demo.env.txt for more clarity.
  • Inside .env File Recently Created Add Following lines of Code
REACT_APP_BOOKSHLF=https://bookshlf.herokuapp.com/
REACT_APP_NODE_ENV=development
  • Save and Restart your Project (if already running) with npm start to make changes Appear.

Screenshots

about addbook address bookdetails cart checkout contact home1 home2 home3 home4 login order recovery search signup wallet wishlist

Future Plans

  • Adding Next Js Framework for Server Side Rendering.
  • Adding React Redux for States centeralization and better API Syncronization.
  • Adding Theme Provider of mui.
  • Full Fledged Admin Panel with Analytics.
  • Adding Night Mode.
  • Ecorrierz API Integration
  • Online Payments (Card / UPI)
  • Coupons
  • Enhanced Search with Recommendations

Note : These are not mandatory upcoming changes. More changes can be introduced later.

Author

Abhishek Singh

Copyright and License

Copyright (c) 2022, Bookshlf.

Bookshlf source code is licensed under the MIT License.

website's People

Contributors

mrhb787 avatar rohitkumar-200 avatar ptlsb avatar vwroli avatar neniya avatar noooooooooob avatar kumarsumit009 avatar logicalahara avatar satyampathak223 avatar rupalisingh avatar juitelavane avatar gaston82 avatar benardcharumbira avatar taticorrea avatar rockingrohit9639 avatar nataliesalemme avatar indremak avatar animeshmore avatar angelicheaven avatar albert-felix avatar mtwn105 avatar ansh-saini avatar arisaokasaka avatar minhhang107 avatar mohsinnajmuddin avatar murattishkul avatar nileshgupta03 avatar taimooralqureshi avatar valwebd avatar wali39 avatar

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.