Kitabay

A Web3 powered eBooks Platform
Explore the docs »

· Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Acknowledgments

About The Project

Kitabay allows users to Publish or Buy a Book as an NFT, once a user has the NFT of a book, he has access to the book's content which can be traded, gifted or resold. Simple Right?

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

pnpm

Installation

Clone the repo

git clone https://github.com/rakshit087/kitabay

Install NPM packages
```
cd kitabay-app
pnpm install
```
Start server by
```
pnpm run dev
```

(back to top)

Roadmap

Web3 Auth for authentication.
Smart Contract Wallet.
on Ramp
Beetter Dashboard

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement" or "feature" Don't forget to give the project a star! Thanks again!

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

Use the following branching structure for making contributions -

Production deployment on main
Dev deployment on dev
Feature branches should be like feature/feature-name
Bug fixes and patch branches should be like patch/patch-name
Improvement to code branches should be like update/update-name

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Acknowledgments

(back to top)