An archived copy of F-Chat Rising before deletion. Many thanks to FireUnderTheMountain on GitHub for having a up-to-date copy. Don't delete your code. People depend on it.

Go to file

MayaWolf ebf7cb43c5 0.2.7 - Profile viewer and many many bug fixes		2017-12-05 02:47:27 +01:00
bbcode	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
chat	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
components	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
cordova	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
electron	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
fchat	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
less	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
site	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
tslint	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
.gitignore	Initial commit.	2017-10-09 23:25:55 +02:00
LICENSE	Initial commit	2017-09-23 10:32:01 -04:00
export-loader.js	Initial commit.	2017-10-09 23:25:55 +02:00
package.json	0.2.2 - Fix Slimcat importer, dependencies and build process	2017-10-17 20:59:23 +02:00
readme.md	0.2.4 - also fix theme building	2017-10-19 01:29:28 +02:00
sfc.d.ts	Initial commit.	2017-10-09 23:25:55 +02:00
tslint.json	0.2.7 - Profile viewer and many many bug fixes	2017-12-05 02:47:27 +01:00
yarn.lock	0.2.2 - Fix Slimcat importer, dependencies and build process	2017-10-17 20:59:23 +02:00

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, Cordova or web application are included.

Setting up a Dev Environment

Clone the repo
Install Yarn
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.
Change into the electron directory.
Run yarn install and then 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.
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.

Building for Cordova

Change into the cordova directory.
Install Cordova using yarn global add cordova.
Run yarn install.
Create a www directory inside the cordova directory and then run cordova prepare to install dependencies.
Run cordova requirements to see whether all requirements for building are installed.
Run yarn build/yarn watch to build assets. They are placed into the www directory.
Run cordova build. For Android, the generated APK is now in platforms/android/build/outputs/apk.

Building a custom theme

See the wiki for instructions on how to create a custom theme.

Change into the less directory.
Run yarn install.
Run yarn build themes/chat/{name}.less {name}.css.

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.