fchat-rising/readme.md

# F-List Exported
This repository contains the open source parts of F-list and F-Chat 3.0.
All necessary files to build F-Chat 3.0 as an Electron, mobile or web application are included.

## Setting up a Dev Environment
 - Clone the repo
 - Install [Yarn](https://yarnpkg.com/en/docs/install)
 - Change into the cloned directory and run `yarn install`. If you only want to make a custom theme, you do not need to do this!
 - IntelliJ IDEA is recommended for development.
 
## Building for Electron
 - To build native Node assets, you will need to install Python 2.7 and the Visual C++ 2015 Build tools. [More information can be found in the node-gyp docs.](https://github.com/nodejs/node-gyp#installation)
 - Change into the `electron` directory.
 - Run `yarn build`/`yarn watch` to build assets. They are placed into the `app` directory.
 - You will probably need to rebuild the native dependencies (`spellchecker` and `keytar`) for electron. To do so, run `npm rebuild {NAME} --target={ELECTRON_VERSION} --arch=x64 --dist-url=https://atom.io/download/electron`. [See the electron documentation for more info.](https://github.com/electron/electron/blob/master/docs/tutorial/using-native-node-modules.md)
 - Run `yarn start` to start the app in debug mode. Use `Ctrl+Shift+I` to open the Chromium debugger.

### Packaging
See https://electron.atom.io/docs/tutorial/application-distribution/
 - Run `yarn build:dist` to create a minified production build.
 - Run `./node_modules/.bin/electron-builder` with [options specifying the platform you want to build for](https://www.electron.build/cli).

## Building for Mobile
 - Change into the `mobile` directory.
 - Run `yarn build`/`yarn watch` to build assets. They are placed into the `www` directory.
 - For Android, change into the `android` directory and run `./gradlew assembleDebug`. The generated APK is placed into `app/build/outputs/apk`.
 - For iOS, change into the `ios` directory and open `F-Chat.xcodeproj` using XCode. From there, simply run the app using the play button.

## Building for Web
 - Change into the `webchat` directory.
 - Run `yarn build`/`yarn watch` to build assets. They are placed into the `dist` directory.
 - The compiled main.js file can be included by an HTML file that is expected to provide a global `const chatSettings: {account: string, theme: string, characters: ReadonlyArray<string>, defaultCharacter: string | null};`. It should also normalize the page to 100% height.

## Building a custom theme
See [the wiki](https://wiki.f-list.net/F-Chat_3.0/Themes) for instructions on how to create a custom theme.
 - Change into the `scss` directory.
 - Run `yarn install`.
 - Run `yarn build themes/chat/{name}.scss`.
 - Your theme file will be placed into the `scss/css` directory.

## Dependencies
Note: Adding *and upgrading* dependencies should only be done with prior consideration and subsequent testing.

That's why `yarn.lock` exists and is version controlled.

To upgrade NPM dependencies, run `yarn upgrade` locally. Run `yarn outdated` to see pending upgrades.
Initial commit. 2017-09-02 01:50:31 +00:00			`# F-List Exported`
			`This repository contains the open source parts of F-list and F-Chat 3.0.`
0.2.16 2018-01-06 16:14:21 +00:00			`All necessary files to build F-Chat 3.0 as an Electron, mobile or web application are included.`
Initial commit. 2017-09-02 01:50:31 +00:00
			`## Setting up a Dev Environment`
			`- Clone the repo`
			`- Install [Yarn](https://yarnpkg.com/en/docs/install)`
0.2.2 - Fix Slimcat importer, dependencies and build process 2017-10-17 18:21:57 +00:00			- Change into the cloned directory and run `yarn install`. If you only want to make a custom theme, you do not need to do this!
Initial commit. 2017-09-02 01:50:31 +00:00			`- IntelliJ IDEA is recommended for development.`

			`## Building for Electron`
0.2.17 - Webpack 4, Bootstrap 4, remove jquery 2018-03-04 02:32:26 +00:00			`- To build native Node assets, you will need to install Python 2.7 and the Visual C++ 2015 Build tools. [More information can be found in the node-gyp docs.](https://github.com/nodejs/node-gyp#installation)`
Initial commit. 2017-09-02 01:50:31 +00:00			- Change into the `electron` directory.
0.2.17 - Webpack 4, Bootstrap 4, remove jquery 2018-03-04 02:32:26 +00:00			- Run `yarn build`/`yarn watch` to build assets. They are placed into the `app` directory.
0.2.2 - Fix Slimcat importer, dependencies and build process 2017-10-17 18:21:57 +00:00			- You will probably need to rebuild the native dependencies (`spellchecker` and `keytar`) for electron. To do so, run `npm rebuild {NAME} --target={ELECTRON_VERSION} --arch=x64 --dist-url=https://atom.io/download/electron`. [See the electron documentation for more info.](https://github.com/electron/electron/blob/master/docs/tutorial/using-native-node-modules.md)
Initial commit. 2017-09-02 01:50:31 +00:00			- Run `yarn start` to start the app in debug mode. Use `Ctrl+Shift+I` to open the Chromium debugger.

			`### Packaging`
			`See https://electron.atom.io/docs/tutorial/application-distribution/`
			- Run `yarn build:dist` to create a minified production build.
			- Run `./node_modules/.bin/electron-builder` with [options specifying the platform you want to build for](https://www.electron.build/cli).

0.2.16 2018-01-06 16:14:21 +00:00			`## Building for Mobile`
			- Change into the `mobile` directory.
0.2.17 - Webpack 4, Bootstrap 4, remove jquery 2018-03-04 02:32:26 +00:00			- Run `yarn build`/`yarn watch` to build assets. They are placed into the `www` directory.
			- For Android, change into the `android` directory and run `./gradlew assembleDebug`. The generated APK is placed into `app/build/outputs/apk`.
			- For iOS, change into the `ios` directory and open `F-Chat.xcodeproj` using XCode. From there, simply run the app using the play button.
Initial commit. 2017-09-02 01:50:31 +00:00
0.2.19 - Lots of polish for stable release. 2018-04-08 00:22:32 +00:00			`## Building for Web`
			- Change into the `webchat` directory.
			- Run `yarn build`/`yarn watch` to build assets. They are placed into the `dist` directory.
			- The compiled main.js file can be included by an HTML file that is expected to provide a global `const chatSettings: {account: string, theme: string, characters: ReadonlyArray<string>, defaultCharacter: string \| null};`. It should also normalize the page to 100% height.

0.2.2 - Fix Slimcat importer, dependencies and build process 2017-10-17 18:21:57 +00:00			`## Building a custom theme`
			`See [the wiki](https://wiki.f-list.net/F-Chat_3.0/Themes) for instructions on how to create a custom theme.`
0.2.17 - Webpack 4, Bootstrap 4, remove jquery 2018-03-04 02:32:26 +00:00			- Change into the `scss` directory.
0.2.2 - Fix Slimcat importer, dependencies and build process 2017-10-17 18:21:57 +00:00			- Run `yarn install`.
0.2.17 - Webpack 4, Bootstrap 4, remove jquery 2018-03-04 02:32:26 +00:00			- Run `yarn build themes/chat/{name}.scss`.
			- Your theme file will be placed into the `scss/css` directory.
0.2.2 - Fix Slimcat importer, dependencies and build process 2017-10-17 18:21:57 +00:00
Initial commit. 2017-09-02 01:50:31 +00:00			`## Dependencies`
			`Note: Adding and upgrading dependencies should only be done with prior consideration and subsequent testing.`

			That's why `yarn.lock` exists and is version controlled.

			To upgrade NPM dependencies, run `yarn upgrade` locally. Run `yarn outdated` to see pending upgrades.