|
||
---|---|---|
bbcode | ||
chat | ||
components | ||
electron | ||
fchat | ||
mobile | ||
scss | ||
site | ||
tslint | ||
.gitignore | ||
LICENSE | ||
keys.ts | ||
package.json | ||
readme.md | ||
tslint.json | ||
webpack.js | ||
yarn.lock |
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
- 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 build
/yarn watch
to build assets. They are placed into theapp
directory. - You will probably need to rebuild the native dependencies (
spellchecker
andkeytar
) for electron. To do so, runnpm 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. UseCtrl+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 Mobile
- Change into the
mobile
directory. - Run
yarn build
/yarn watch
to build assets. They are placed into thewww
directory. - For Android, change into the
android
directory and run./gradlew assembleDebug
. The generated APK is placed intoapp/build/outputs/apk
. - For iOS, change into the
ios
directory and openF-Chat.xcodeproj
using XCode. From there, simply run the app using the play button.
Building a custom theme
See the wiki 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.