Skip to content

Bookshlf Website Frontend (currently in development)

Notifications You must be signed in to change notification settings

kalyan-achyuta/Website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bookshlf

Online Second Hand book store specially for Competitive Exams.

We are a small team of students who are enthusiastic developers. We are trying to create a better viable platform for students who want to learn but due to financial issues can't afford new books. We also want to help those who want to sell thier books which they don't need. We hope that you will find this platform usefull. We are always trying to make this platform better and better.

Built With

Contributing

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

Contributors

Made with contributors-img.

Don't forget to ⭐ this repository !!

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

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! :)

Screenshots

Will be Uploaded Soon

About

Bookshlf Website Frontend (currently in development)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 96.0%
  • CSS 3.9%
  • HTML 0.1%