Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/namandangi/manga

Your Favourite Comic-Reader!
https://github.com/namandangi/manga

electron-app hacktoberfest heroku jquery mangas mern-stack mongodb mongoose netlify nodejs reactjs selenium web-scraping

Last synced: 2 days ago
JSON representation

Your Favourite Comic-Reader!

Awesome Lists containing this project

README

        

[![HitCount](http://hits.dwyl.io/namandangi/comics.svg)](http://hits.dwyl.io/namandangi/comics) ![](https://img.shields.io/github/issues/namandangi/manga?style=flat-square) ![](https://img.shields.io/github/languages/top/namandangi/manga?style=flat-square) ![](https://img.shields.io/github/languages/count/namandangi/manga?style=flat-square)



Logo

Manga!


A web-scraper based Manga Reader!


Explore the docs »




View Demo
|
Report Bug
|
Request Feature


![](https://github.com/namandangi/comics/blob/master/public/screenshots/landing.png)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/authentication.png)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/404.png)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/searchManga.png)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/mangaList.jpg)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/chapterList.png)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/mangaChapter.jpg)
![](https://github.com/namandangi/comics/blob/master/public/screenshots/desktopApp.jpeg)

## Technology Stack :

1. ExpressJS for server library.
2. Node.js for Environment.
3. React.js for developing dynamic user interfaces
4. Axios for promise based HTTP requests
5. Cheerio.js for quick and flexible implementation of core jQuery
6. Puppeteer for headless-browser based scraping
7. Electron.js for Desktop-client app.

## Build Instructions

#### 1. First the clone the repository locally by

```
git clone https://github.com/namandangi/manga
```

and change directory into the project using

```
cd ./manga
```

#### 2. Install all server-side packages

In the root directory of the backend project using

```
npm install
```

#### 3. Run the backend-server

In the root directory of the backend using

```
npm start
```

and change directory into the webapp using

```
cd ./webapp
```

#### 4. Install all client-side packages

In the root directory of the webapp using

```
npm install
```

#### 5. Run the client-server

In the root directory of the webapp using

```
npm start
```

#### 6. Run the desktop-client after the client-server loads

In the root directory of the webapp using

```
npm run electron
```

#### 7. Optionally run the desktop & client server togethor

In the root directory of the webapp setup the startUrl in ` electron.js` file and then run

```
npm run dev
```

## Run Test

In the root directory of the project run

```
npm test
```

## Contributing

1. Fork it (https://github.com/namandangi/manga/fork)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -m 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request