Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 143 lines (111 sloc) 5.115 kb
de343c22 »
2012-10-25 Update readme file
1 MangaWeb3
2 ====================
3
4 A web app for reading manga on all your devices.
5
6 Set up a server. Add your manga (or other books). Open the web app from your favourite browser.
7 The server will read your manga and resize to fit your browser.
8
9 The web app works on desktop browsers, phone browsers, tablet browsers and even browsers on Kindle.
10
11 There are two favours of server.
12 The ASP.NET version runs on Windows and the PHP version runs on Unix systems.
13
14 Features
15 --------
16
17 - Reads Zip, RAR and PDF files
18 - Multi-platform (both server and client)
19 - Resize each page to fit the browser
20 - Password protect a collection of your manga
21 - Client app support touch devices (iOS, Android, Windows 8)
22 - Load pages only before you are going to read it
23 - Multi-language client app and easy to add new language
24 - Easy customization by editing template HTML files and CSS files
25
26
27 Demo
28 ----
29
30 - [ASP.NET Version hosted on Windows Azure Virtual Machine](http://demoaspnet.mangaweb.info)
31 - [PHP Version hosted on DreamHost](http://demophp.mangaweb.info)
32 - [PHP Version on my Raspberry Pi](http://demopi.mangaweb.info:9001) (Uptime is not guaranteed.)
33
34
35 Server Requirement (ASP.NET)
36 ----------------------------
37
38 - IIS (Tested with 7 and 8)
39 - ASP.NET 4.0 or 4.5
40 - MySQL Server (Tested with 5.5)
41 - (Optional) 7-zip
42 - (Optional) Microsoft Visual C++ 2010 Redistributable Package
43
44
45 Server Requirement (PHP)
46 ------------------------
47
48 - A server to run php (Tested with Apache 2.0)
49 - PHP 5.1.0 or above (Tested with 5.3)
50 - MySQL Server (Tested with 5.5)
51 - MySQL extension in PHP
52 - GD extension in PHP
53 - (Optional) Zip extension in PHP
54 - (Optional) RAR extension in PHP
55 - (Optional) pdfinfo and pdfdraw
56
57 Browser Support
58 ---------------
59
60 - Internet Explorer 9+
61 - Firefox 10+
62 - Chrome 12+
63 - Safari 4+
64 - Safari in iOS 3.2+
65 - Chrome for Android
66 - Firefox for Android
67 - Kindle browser (Tested on Kindle 4 NT only)
68
69
70 Quick Start
71 ===========
72
73 Compiling the source
74 --------------------
75
76 You need the following tools
77 - Visual Studio
78 - [Script#](http://scriptsharp.com/) (7.4.0 or above)
79 - [Haxe compiler](http://haxe.org/download)
80 - [LESS](http://lesscss.org/)
81
82 To compile:
83 - Open `source/afung.MangaWeb3.sln` in Visual Studio and compile
84 - Use `haxe -cp . -php source/haxephp -main afung.mangaWeb3.server.ServerAjax` to compile the Haxe source to PHP
85 - Use a LESS compiler to compile `source\less\mangaweb.less` and copy `mangaweb.css` to `source\aspnetserver\css`
86 - run `gather_aspnet.ps1` in Windows PowerShell and files under `output\aspnet` are ready to deploy to a Windows server
87 - run `gather_php.ps1` in Windows PowerShell and files under `output\php` are ready to deploy to a Unix server
88 - (Optional) replace `output\aspnet\bin\PDFLibNet.dll` with `external_libraries\x86\PDFLibNet.dll` if you are going to deploy it to a 32-bit Windows machine
89
90 Pre-compiled binaries and scripts
91 ---------------------------------
92
93 Pre-compiled packages can be downloaded [here](https://github.com/a-fung/MangaWeb3/downloads)
94
95
96 Deploy to a Windows server
97 --------------------------
98
99 - Create an empty database in MySQL first
100 - Copy all the files to your server
101 - Make a new application or a new website pointing to where you placed to files
102 - Give full control permission to `empty.pdf` file and `cover` and `mangacache` directories to your IIS Application Pool
103 - Open `install.html` from your browser and specify MySQL server information, location of 7z.dll and information to create administrator
104 - (Optional) Delete `install.html`, `bin\afung.MangaWeb3.Server.Install.dll`, `js\afung.MangaWeb3.Client.Install.js`, `template\install.html` from your server
105 - (Optional) Copy ASP.NET Version of CKFinder to `ckfinder` directory (do not replace `config.js` and `config.ascx`) and copy `CKFinder.dll` to `bin` directory
106 - Now your server is ready to add manga and to be used. `admin.html` is the administration page. `index.html` is the client app.
107
108 Deploy to a Unix server
109 -----------------------
110
111 - Create an empty database in MySQL first
112 - Copy all the files to your server
113 - Give write permission to `temp`, `cover` and `mangacache` directories
114 - Open `install.html` from your browser and specify MySQL server information and information to create administrator
115 - (Optional) Delete `install.html`, `lib\afung\mangaWeb3\server\install`, `js\afung.MangaWeb3.Client.Install.js`, `template\install.html` from your server
116 - (Optional) Copy PHP Version of CKFinder to `ckfinder` directory (do not replace `config.js` and `config.php`)
117 - Now your server is ready to add manga and to be used. `admin.html` is the administration page. `index.html` is the client app.
118
119 ----------------------------------------------------------------------------------------------
120
121 Develop & Test Enviroment
122 =========================
123
124 - Windows 7
125 - Visual Studio 2010 Ultimate
126 - Script# 7.4.0
127 - Haxe
128 - FlashDevelop 4
129 - SimpLESS 1.4
130 - IIS 7
131 - ASP.NET 4.0
132 - MySQL 5.5
133 - Internet Explorer 9
134 - Firefox (Latest)
135 - Chrome (Latest)
136 - Debian 6
137 - Apache 2.0
138 - PHP 5.3
139 - MySQL 5.5
140 - Raspbian “wheezy” (2012-09-18)
141 - Apache 2.0
142 - PHP 5.3
143 - MySQL 5.5
Something went wrong with that request. Please try again.