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.
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.
2017-09-02 01:50:31 +00:00
## Setting up a Dev Environment
- Clone the repo
- Install [Yarn ](https://yarnpkg.com/en/docs/install )
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!
2017-09-02 01:50:31 +00:00
- IntelliJ IDEA is recommended for development.
## Building for Electron
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 )
2017-09-02 01:50:31 +00:00
- Change into the `electron` directory.
2018-03-04 02:32:26 +00:00
- Run `yarn build` /`yarn watch` to build assets. They are placed into the `app` directory.
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 )
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 ).
2018-01-06 16:14:21 +00:00
## Building for Mobile
- Change into the `mobile` directory.
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.
2017-09-02 01:50:31 +00:00
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.
2018-03-04 02:32:26 +00:00
- Change into the `scss` directory.
2017-10-17 18:21:57 +00:00
- Run `yarn install` .
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.
2017-10-17 18:21:57 +00:00
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.
