Skip to content

Latest commit

 

History

History
234 lines (153 loc) · 5.92 KB

README.md

File metadata and controls

234 lines (153 loc) · 5.92 KB

logo

Book Store

App Mock

logo

📗 Table of Contents

📖 Book Store

This Project is for organizing your books and check the status of your reading

Book Store is a React-oriented project and Api based Project, where you can add book to server and get books from the server

🧪 Linters And Deployment

Linters Netlify Status

🛠 Built With

Tech Stack

In this project I used many skills, tech and libraries

Documentation
Styling
Dynamics And Logics
FrameWork

Key Features

  • You can add your favorite books
  • A home page
  • An functionality to check the status
  • An functionality to update status

(back to top)

🚀 Live Demo

This link will guide you to my project

(back to top)

💻 Getting Started

For having local file and project you can fork this repo or clone it using git clone https://github.com/PowerLevel9000/book-store.git And for making changes you you should follow prerequisites

Prerequisites

In order to edit this project you need:

  • Any text editor such as note pad and word pad
  • A web browser
  • Node js installed
  • An IDE

Suggested IDE

  • Visual studio code I prefer this one 🙃🙃
  • Atom
  • Sublime
  • IntelliJ IDEA
  • Visual code

Setup

Clone this repository to your desired folder:

  • Open your terminal there (bash cmd powershell run etc...) and run npm i to install node modules

  • npm start this will open project in browser

  • If you to edit something edit in src dir and then run in terminal npm run build to build it for production

  • Before deployment have some linter check

    • npx stylelint "**/*.{css,scss}" for css and saas file
    • npx eslint . for js files
    • npx hint . for html files
  • After fixing error build deploy for production

Install

npm i 

Usage

Execute the following thing:

  • books adding and removing
  • check status

Deployment

You can deploy this project using:

  • Fork our Repo and clone it or download zip and extract it
  • Edit some changes
  • Run npm run build to make our project production ready
  • deploy it using GitHub pages (gh-pages run npm i -D gh-pages )
  • also, you can use netlify to deploy it

(back to top)

👥 Authors

👤 Adarsh Pathak

🔭 Future Features

  • mobile and tablet version
  • improve functionality
  • improve styling
  • Some more pages

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like my Project give it a Star ✨🌟

(back to top)

❓ FAQ

ask questions to be here

  • Question_1 How to add a book

    • Answer_1 submit the form to add a book
  • Question_2 How to remove a book

    • Answer_2 Just Tap on the remove button and wait for a while

(back to top)

📝 License

This project is MIT licensed.

(back to top)