Bookshlf Website Frontend.
Online E-Commerce Store for Selling & Purchasing Used Books. Specially for Competitive Exams.
# | Title | ||
---|---|---|---|
1 | Built | ||
2 | Requirements | ||
3 | Setup Locally | ||
4 | Contribute | Contributing | Contributers |
5 | API Keys | ||
6 | Sample Screens | Visit Store |
You will need node
and npm
installed globally on your machine.
$ npm -v
The terminal should return your npm version.
NOTE : npm version 14 and above is required!
$ git clone https://github.com/Bookshlf-in/Website.git
$ npm install
or
$ npm i
$ npm run start or npm start
Love the project and want to get involved? You’re in the right place!
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. Basic CI Checks should pass and when approved, your branch will be merged into master and you're done! Thanks for contributing!
This is a Neccessary Step to make APIs Work.
.env
into Main Repository Folder eg : ...\Website\.env
.Demo.env.txt
for more clarity..env
File Recently Created Add Following lines of CodeREACT_APP_BOOKSHLF=http://localhost:4000
REACT_APP_NODE_ENV=development
npm start
to make changes Appear.Made with contributors-img.
Don't forget to ⭐ this repository !!
Note : These are not mandatory upcoming changes. More changes can be introduced later.
Abhishek Singh
Copyright (c) 2022, Bookshlf.
Bookshlf source code is licensed under the MIT License.