Read Tracker

Search and browse a collection of books and add them to your library. You can trace the progress of each book and add books to a want to read list.

View Project · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

Here's what you can find:

• Info about me and what I do.
• Projects I built and the tech stack used in each one.
• Programming languages, frameworks, and tools that I use.

Built With

• Vite
• Vue.js
• Tailwind CSS
• Headless UI

Getting Started

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

Prerequisites

• Node.js & npm installed.
• Git and any terminal to run commands.

Installation

1. Clone the repo

   git clone https://github.com/omar-labana/read-track.git

2. Install NPM packages

   npm install

Usage

1. Run the dev server

   npm run dev | npm run start

2. Open http://localhost:3000/ in your browser
3. Start tracking books!

Contributing

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Omar - @panda4cs - omarlabana@outlook.com