Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/book-store

Bookstore is a website that let's users add and remove book information such as Author and Title. Books information is added and accessed from a bookstore API.
https://github.com/stephenkati/book-store

bookstore-api javascript react redux

Last synced: 23 days ago
JSON representation

Bookstore is a website that let's users add and remove book information such as Author and Title. Books information is added and accessed from a bookstore API.

Host: GitHub
URL: https://github.com/stephenkati/book-store
Owner: stephenkati
License: mit
Created: 2023-05-04T11:08:08.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-12-16T16:18:15.000Z (11 months ago)
Last Synced: 2024-10-03T00:41:45.585Z (about 1 month ago)
Topics: bookstore-api, javascript, react, redux
Language: JavaScript
Homepage:
Size: 957 KB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        



  

 

  


  
Bookstore




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [Video-presentation](#presentation)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [Bookstore]

 **[Bookstore]** is a website that let's users add and remove book information such as Author and Title. Books information is added and accessed from a bookstore API.

## 🛠 Built With 

### Tech Stack 

  Client

  


    CSS

    JavaScript

    React js

  


  Server

  


    No Server build yet

  


Database

  


    No database build yet

  


### Key Features 

- **[Used Linters]**

- **[Great summary for the repo]**

- **[Use of GitFlow]**

(back to top)


## 💻 Getting Started 

A new developer can get the project from my Github repo link i shall provide.

To get a local copy up and running, follow these steps.

go to https://github.com/stephenkati/book-store.git

clone or download the project

Run `npm install`

Run `npm start`

### Prerequisites

In order to run this project you need:

-A code editor, preferably VSCode. Any other code editor is okay.

-Browser

### Setup

Clone this repository to your desired folder:

Run `git clone https://github.com/stephenkati/book-store.git`

or

In the File menu, click Clone Repository.

Click the tab that corresponds to the location of the repository you want to clone. You can also click URL to manually enter the repository location.

Choose the repository you want to clone from the list.

Click Choose... and navigate to a local path where you want to clone the repository.

Click Clone.

### Install

Install this project with:

Download the project from github and run it in your browser.

Install dependencies.

`npm install`

### Usage

To run the project, navigate to the project directory and use a live Server extension in your VSCode to run the project.

Run `npm start` 

### Run tests

You can run tests to check for linter errors by running the following commands:

- `npx stylelint "**/*.{css,scss}"` for testing css errors

- `npx eslint "**/*.{js,jsx}"` for Javascript errors

(back to top)


## 👥 Authors 

👤 **Stephen Katuli**

- GitHub: [@githubhandle](https://github.com/stephenkati)

- Twitter: [@twitterhandle](https://twitter.com/Stephen57913145)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)


## 🔭 Future Features 

- [ ] **[More backround images]**

- [ ] **[Animations and transitions]**

- [ ] **[More Javascript Functionality]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

I am very grateful to Zeplin for the design I used.

Feel free to check the [issues page](https://github.com/stephenkati/book-store/issues).

(back to top)


## ⭐️ Show your support 

If you like this project please reach out to me on my social media, hire me for more content like this.

(back to top)


## 🙏 Acknowledgments 

I would like to thankmy Microverse team and my coding partners for their support and guidance.

(back to top)


##  PRESENTATION  

**PROJECT PRESENTATION VIDEO**

No presentation done yet.

## ❓ FAQ (OPTIONAL) 

- **[How good are your communication skills?]**

  - [I have good writting and speaking communication skills in English.]

- **[What else do you do apart from coding?]**

  - [I do graphics design.]

(back to top)


## 📝 License 

This project is [MIT](/LICENSE.md) licensed.

(back to top)