Coder Social home page Coder Social logo

awesome-books's Introduction

logo logo

Awesome Books

logo

๐Ÿ“— Table of Contents

๐Ÿ“– Awesome Books

This Project for individual purpose and it organize your fav books

Awesome Books is just a javascript based simple project

๐Ÿงช Linters And Deployment

Linterspages-build-deployment

๐Ÿ›  Built With

Tech Stack

In this project we used many skills, tech and libraries

Documentation
Styling
Dynamics And Logics

Key Features

Following features you should observe

  • You can add your fav book
  • Yoc can remove it if you loose interest or mood swings

(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/Awesome-Books.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 run dev or npm run 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

  • Navigation bar using SPA
  • Book added to shelf

Run tests

  • Check whether your fav book added
  • Check your mood swings works ๐Ÿง‘โ€๐Ÿซ๐Ÿ˜ according to my project

Deployment

You can deploy this project using:

  • for this repo and use git hub pages to deploy it

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Adarsh Pathak

๐Ÿ‘ค Dilsher Balouch

๐Ÿ”ญ Future Features

  • Add navigation bar
  • improve functionality
  • improve styling

(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)

๐Ÿ™ Acknowledgments

I want to thank Microverse for giving me opportunity to show my skills

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

awesome-books's People

Contributors

dilsherb avatar powerlevel9000 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

awesome-books's Issues

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.