📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
      • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Bookstore CMS

Bookstore is a simple book app for reading and updating progress of books.

🛠 Built With

Tech Stack

The following tech stack was used to build this project:

Client

• JavaScript
• React

Key Features

• View books
• View current book progress

(back to top)

🚀 Live Demo

View a deployed and ready version of the app on Render

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  npm 

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/peterdtitan/bookstore.git

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests using jest, run the following command:

  npm test

(back to top)

👥 Authors

The following users authored this project codebase:

👤 Author1

• GitHub: Peter Okorafor
• Twitter: PeterDeTitan
• LinkedIn: Peter OKorafor

🔭 Future Features

In the future, the following features will be considered:

• Better UI

(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 this project please follow and give it a star ⭐️

(back to top)

❓ FAQ

• Is this an Open Source Project?

  • Yes it is, however, there would not be subsequent deployments and maintenance of the app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)