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

https://github.com/whdzera/kitsu-manga

A web manga reader built with Ruby on Rails, featuring a clean interface and seamless reading experience.
https://github.com/whdzera/kitsu-manga

bulma-css manga manga-reader rails ruby

Last synced: 3 months ago
JSON representation

A web manga reader built with Ruby on Rails, featuring a clean interface and seamless reading experience.

Awesome Lists containing this project

README

          

# Kitsu Manga

Kitsu Manga is a web reading manga written in Ruby on Rails, featuring a clean interface and seamless reading experience.

## View

## Features

- UI with Bulma & FA
- login/regist auth with Devise
- login/regist anti bot with Hcaptcha
- Email confirmation register with Action Mailer
- Pagination with Kaminari
- Role: Admin, Member, Guest(without regist)
- Admin dashboard: User and Manga management, reports, etc
- Profile users: About, Rencet fav manga, etc
- Bookmarks System
- Comments system

## Tech Stack

- Ruby on Rails (Backend)
- SQLite (Database) for development, can be switched to MySQL or PostgreSQL
- Bulma and Font-awesome (Styling and icon)
- Stimulus (Interactive)

### Prerequisites

- Ruby (3.3.0)
- Rails (8.0.1)
- ImageMagick (6.9.11)

### Setup

1. Clone this repository:
```sh
git clone https://github.com/whdzera/kitsu-manga.git
cd kitsu-manga
```
2. Install dependencies:
```sh
bundle install
```
3. Setup the database:
```sh
rails db:setup
```
4. Start the Rails server:
```sh
rails server
```

## Developer Tool

Run Rails Development mode:
```sh
rake dev
```

Run Unit Test:
```sh
rake test
```

## Contributing

1. Fork the repository.
2. Create a new branch: `git checkout -b feature-branch`
3. Make your changes and commit them: `git commit -m 'Add new feature'`
4. Push to the branch: `git push origin feature-branch`
5. Create a pull request.

## Gists

- [Automation increase chapter in kitsumanga](https://gist.github.com/whdzera/b99aa5c9d2d779a52ae4e2fc9b132e99)

## License

`Do not deploy on a public server without my permission`

This project is licensed under the Apache License.

## Contact

For any questions or suggestions, feel free to open an issue on GitHub.