Commit Graph

51 Commits

Author SHA1 Message Date
Lorenzo Blasa
57584a38fa Electron distribution announcement
Summary:
Update our README file with an announcement of our distribution change. I will pair the announcement with an update to our GitHub workflow as to not produce any more Electron builds for future releases.

Changelog: Flipper Electron distribution change announcement.

Reviewed By: aigoncharov

Differential Revision: D51616454

fbshipit-source-id: 5ff513b3d99c8100ed8241d1bdafebf1d6dcfa10
2023-11-28 09:03:54 -08:00
Pascal Hartig
fdcd3fca11 Update README (#4350)
Summary:
Stack created with [Sapling]
* __->__ https://github.com/facebook/flipper/issues/4350

Update README
Mainly to test out Sapling, but also to get rid of some "recently"s that are not longer all that recent.

Pull Request resolved: https://github.com/facebook/flipper/pull/4350

Test Plan: _eyes

Reviewed By: antonk52

Differential Revision: D41653401

Pulled By: passy

fbshipit-source-id: 39aac6dcd3bb427f93bd725fbb587c8aac7ffba4
2022-12-05 07:57:16 -08:00
Andrey Goncharov
13e06803c9 Migrate React Native Example app to react-native 0.69 (#4265)
Summary:
// allow-large-files

Pull Request resolved: https://github.com/facebook/flipper/pull/4265

Related to https://github.com/facebook/flipper/issues/4240

Resolving https://github.com/facebook/flipper/issues/3859 led to breaking changes in react-native-flipper which made it incompatible with react-natvie < 0.69.
In this diff we migrate our example app to react-native 0.69 and add a notice to our readme about the react-native 0.69+ requirement

Reviewed By: lblasa

Differential Revision: D40673740

fbshipit-source-id: 18f4742449d115be7a5100f2bc4d834dcebea80f
2022-10-25 10:40:44 -07:00
Lorenzo Blasa
c69e737f19 README update
Summary: Add instructions for building and running our RNW sample application.

Reviewed By: antonk52

Differential Revision: D39305056

fbshipit-source-id: 2adb41d713381c1b79ea5fe55a4f8a40d43e7f4c
2022-09-07 03:53:50 -07:00
Luke De Feo
bea884a682 fix broken link in docs
Summary: .

Reviewed By: lblasa

Differential Revision: D38312702

fbshipit-source-id: d3296dfe65b3ba4242a47179ec08911c500bf2d5
2022-08-01 09:27:19 -07:00
Simon Marquis
4730c417bc Fix typo in image url in README.md (#3929)
Summary:
Introduced in 40e65901bd

Pull Request resolved: https://github.com/facebook/flipper/pull/3929

Reviewed By: lblasa

Differential Revision: D38314975

Pulled By: LukeDefeo

fbshipit-source-id: 73240f1bd66d9d119b6e726ee45ca2fc7b0bbcc5
2022-08-01 08:20:37 -07:00
Pascal Hartig
40e65901bd Update README.md (#3843)
Summary:
Old image was 404ing.

Pull Request resolved: https://github.com/facebook/flipper/pull/3843

Reviewed By: nikoant

Differential Revision: D37311708

Pulled By: passy

fbshipit-source-id: 37dc2a84f1b5471480fbde587bb5b0ed6b21446e
2022-06-21 07:37:21 -07:00
Michel Weststrate
7efad4201c Document how to use Node.js api's
Summary:
* Documented `npx flipper-server`
* Documented how to properly interact with the OS from Flipper plugins

Reviewed By: antonk52

Differential Revision: D33361929

fbshipit-source-id: 3028de2bf77a9ee6d9e521c1a53cff2388c936ea
2022-01-04 09:06:15 -08:00
Andrey Goncharov
5610f8f058 Remove 'path' from plugins
Summary:
1. Add `path` replacement
1. Remove Node's path for all plugins but MobileBuildsPluginContainer (it is probably going to be moved to the server)

Reviewed By: mweststrate

Differential Revision: D32766327

fbshipit-source-id: e636f273842506e752b97cf1b28ce7ac51ce9a12
2021-12-02 04:14:51 -08:00
Lorenzo Blasa
965ef49943 Updated documentation for React Native Example iOS
Summary:
The existing react native example ios documentation is not entirely accurate.

```pod install --repo-update```

If is the first time running, that command needs to be run prior to running `yarn ios`

Reviewed By: fabiomassimo

Differential Revision: D32666486

fbshipit-source-id: aa09d69d16010a7b55c9ac51eb63a0a012d8e987
2021-11-25 07:02:50 -08:00
Andrey Goncharov
9b16d0c29a Add documentation
Summary: Document Flipper integration with JavaScript clients.

Reviewed By: passy

Differential Revision: D31827187

fbshipit-source-id: c40d8820241c0f85bd2366a0c087d4270d316c71
2021-10-22 06:30:15 -07:00
Pradumna Saraf
0184218403 Corrected Unreachable Plugins Dir Path (#2952)
Summary:
**All the 4 plugins paths are unreachable/changed in [in-this-repo](https://github.com/facebook/flipper#in-this-repo) section in README file. I have updated them with the correct paths.**

- **Before Changes**

![1](https://user-images.githubusercontent.com/51878265/136379185-8325343b-29f4-444e-8a1a-f13bc6900312.png)

- **After Changes**

![2](https://user-images.githubusercontent.com/51878265/136379474-db506b65-7505-42cb-bdad-1d7e545c53e9.png)

Pull Request resolved: https://github.com/facebook/flipper/pull/2952

Reviewed By: muraziz

Differential Revision: D31502036

Pulled By: passy

fbshipit-source-id: 6f2af9d312045704e1bb2efec4f841022ebbfaaa
2021-10-08 05:13:24 -07:00
Pascal Hartig
68763e8e74 Remove Travis reference (#2691)
Summary:
We aren't using that anymore.

Pull Request resolved: https://github.com/facebook/flipper/pull/2691

Reviewed By: mweststrate

Differential Revision: D30305791

Pulled By: passy

fbshipit-source-id: 605f744888bb9d9ed4b3ad2b59b2d884b783056f
2021-08-16 05:41:18 -07:00
Pascal Hartig
781df776f2 Rename default branch references to main (#2689)
Summary:
I really hope I hit everything and didn't break anything that wasn't
referring to branch names.

Pull Request resolved: https://github.com/facebook/flipper/pull/2689

Test Plan:
_eyes

CI

|[Site Preview: flipper](https://our.intern.facebook.com/intern/staticdocs/eph/D30305789/V2/flipper/)

Reviewed By: timur-valiev

Differential Revision: D30305789

Pulled By: passy

fbshipit-source-id: 5daaa09250bb96bb50be679fc01dae86c666eb73
2021-08-13 15:00:39 -07:00
Pascal Hartig
c1b43f44b0 Update Maven badge in Readme
Summary: Jcenter is ded. Using a Maven Central badge instead.

Reviewed By: mweststrate

Differential Revision: D26399859

fbshipit-source-id: dbbf0ede62ec4b5b76aaa21fbbed8754a3378451
2021-02-12 04:36:10 -08:00
Igor Strebezhev
0100224833 Highlight code in the README.md (#1540)
Summary:
Thanks for `flipper` ;)

Pull Request resolved: https://github.com/facebook/flipper/pull/1540

Reviewed By: nikoant

Differential Revision: D23817144

Pulled By: passy

fbshipit-source-id: 97a0b6ba12169bae4a7df821051704adc411bc89
2020-09-21 10:32:45 -07:00
Samyukta Varshney
fe93bce589 Removing Extra space (#1464)
Summary:
Removing extra space in README.md

## Changelog

Change in README.md

Pull Request resolved: https://github.com/facebook/flipper/pull/1464

Test Plan: Removing extra space between text

Reviewed By: cekkaewnumchai

Differential Revision: D23103953

Pulled By: passy

fbshipit-source-id: e5f0b6338d64ca2384fe1c42efce1604088c6ce7
2020-08-13 08:08:49 -07:00
Darsh Shah
56a85ae9dd feat(docs): Update README.md (#1395)
Summary:
> Updating Readme.md file. This will make it look a lot cleaner.

### Changes
- [x] Added Flipper logo
- [x] aligning header elements to center

Pull Request resolved: https://github.com/facebook/flipper/pull/1395

Reviewed By: jknoxville

Differential Revision: D22661963

Pulled By: mweststrate

fbshipit-source-id: 01c495da3037a28a9f69907f8f94e42e77143d10
2020-07-22 04:17:20 -07:00
Pascal Hartig
a48034f1fd Fix image path in README (#1197)
Summary:
^
Pull Request resolved: https://github.com/facebook/flipper/pull/1197

Test Plan: eyes

Reviewed By: mweststrate

Differential Revision: D21719319

Pulled By: passy

fbshipit-source-id: ed1e969de3ced5c8701badf3d229d1c3c3d10dff
2020-05-26 07:07:39 -07:00
Pascal Hartig
770c8b4d00 Remove greenkeeper (#1138)
Summary:
Pull Request resolved: https://github.com/facebook/flipper/pull/1138

Goodnight, sweet prince.

Reviewed By: nikoant

Differential Revision: D21426321

fbshipit-source-id: 8d0ffb479ee806e792e2c1351fec6b14690812bc
2020-05-06 10:58:28 -07:00
Tomasz Czajęcki
b7775ef227 Fix link to docs (#1118)
Summary:
Link to documentation in the README is broken. I have replaced it with a working one.

## Changelog

Fixed link to the docs in README
Pull Request resolved: https://github.com/facebook/flipper/pull/1118

Test Plan: Check out both links in the browser.

Reviewed By: mweststrate

Differential Revision: D21402065

Pulled By: passy

fbshipit-source-id: 809adc30dcfa1543a00adfe84322e1bd1b9511a7
2020-05-05 07:55:22 -07:00
Pascal Hartig
01f8d80402 Fix getting started link from README (#1065)
Summary:
Fix https://github.com/facebook/flipper/issues/1064.
Pull Request resolved: https://github.com/facebook/flipper/pull/1065

Test Plan: eyes

Reviewed By: jknoxville

Differential Revision: D21257849

Pulled By: passy

fbshipit-source-id: 9e973b8eceef66b9ceaaba1c326b07c92817316d
2020-04-27 11:19:33 -07:00
John Knox
f1e8297800 Fix broken links on website and github readme
Summary:
The url for the getting started page was changed yesterday. (no longer getting-started.html)
This fixes some links that were broken because of it.

Reviewed By: cekkaewnumchai

Differential Revision: D20855343

fbshipit-source-id: 788efb75f3581e4fe6cecd5f69f11dd64b03e7df
2020-04-04 02:30:52 -07:00
Anton Nikolaev
0e920e8558 Few fixes in docs after folders re-arrangements
Summary: Few fixes in docs after folders re-arrangements

Reviewed By: mweststrate

Differential Revision: D20465905

fbshipit-source-id: f65a154731a9956cd0cb6ab66a42eaeecaaf8af0
2020-03-16 03:29:04 -07:00
Anton Nikolaev
10d990c32c Move plugins to "sonar/desktop/plugins"
Summary:
Plugins moved from "sonar/desktop/src/plugins" to "sonar/desktop/plugins".

Fixed all the paths after moving.

New "desktop" folder structure:
- `src` - Flipper desktop app JS code executing in Electron Renderer (Chrome) process.
- `static` - Flipper desktop app JS code executing in Electron Main (Node.js) process.
- `plugins` - Flipper desktop JS plugins.
- `pkg` - Flipper packaging lib and CLI tool.
- `doctor` - Flipper diagnostics lib and CLI tool.
- `scripts` - Build scripts for Flipper desktop app.
- `headless` - Headless version of Flipper desktop app.
- `headless-tests` - Integration tests running agains Flipper headless version.

Reviewed By: mweststrate

Differential Revision: D20344186

fbshipit-source-id: d020da970b2ea1e001f9061a8782bfeb54e31ba0
2020-03-14 14:35:18 -07:00
Anton Nikolaev
85c13bb1f3 Move desktop-related code to "desktop" subfolder (#872)
Summary:
Pull Request resolved: https://github.com/facebook/flipper/pull/872
Move all the JS code related to desktop app to "desktop" subfolder.

The structure of "desktop" folder:
- `src` - JS code of Flipper desktop app executing in Electron Renderer (Chrome) process. This folder also contains all the Flipper plugins in subfolder "src/plugins".
- `static` - JS code of Flipper desktop app bootstrapping executing in Electron Main (Node.js) process
- `pkg` - Flipper packaging lib and CLI tool
- `doctor` - Flipper diagnostics lib and CLI tool
- `scripts` - Build scripts for Flipper desktop app
- `headless` - Headless version of Flipper app
- `headless-tests` - Integration tests running agains Flipper headless version

Reviewed By: passy

Differential Revision: D20249304

fbshipit-source-id: 9a51c63b51b92b758a02fc8ebf7d3d116770efe9
2020-03-14 14:35:17 -07:00
Michel Weststrate
0fa0899299 Create React Native example project
Summary:
This diff creates a sample React Native project (based on the 0.62-rc.0 template).

This example is created like:
(Documenting this here as in the future this might be easier than upgrading the project itself)

1. Run `npx react-native init ReactNativeFlipperExample --version 0.62.0-rc.0`
2. Follow the installation steps to enable Flipper, that is, call `initializeFlipper(this, getReactNativeHost().getReactInstanceManager());` at the end of the `onCreate` method in `MainApplication.java`
3. Put `FlipperTicTacToe` in the root of the project, and call it from `App.js` as a component
4. install `react-native-flipper` as dependency
5. install `relative-deps` as dev dependency, and set it up as shown in `package.json`. This tool make sure that we build and test this project against the version of react-native-flipper in this repository, rather than against the one on NPM.
6. removed some stuff, like tests and linting, which is just in the way in this repo

This PR does not support iOS, as Flipper + RN iOS is still broken in 0.62.0-rc.0, and the current version of react-native-flipper doesn't support iOS yet either.

Documentation on how to set up Flipper in general is not part of this Diff

_N.B. since this is a **public** project, to be visible and runnable by our OSS community, the build setup is kept plain, vanilla, react-native, and **not** wired up to our normal / internal build processes. This is also the reason that lint suggestions beyond the license headers have been ignored. If any others should be applied, it is probably the official react native template that requires updating_

Reviewed By: passy

Differential Revision: D19449295

fbshipit-source-id: 2aeb6044f8dd01f09a95350c84fff2419d685a65
2020-01-23 04:47:52 -08:00
Gant Laborde
f6dc82f2af Simple small comma adjustments (#600)
Summary:
Not important, just fixing a few commas.

## Changelog
Pull Request resolved: https://github.com/facebook/flipper/pull/600

Differential Revision: D18087297

Pulled By: passy

fbshipit-source-id: 00d867af4b2e294b55cbc5ed4ebb3a2b0261d598
2019-10-23 10:25:07 -07:00
Pascal Hartig
d277e1da9e Show up-to-date image (#585)
Summary:
The previous one was a bit outdated. It's only used in low-res
environments otherwise where that's fine, but let's a more recent
one for the README header.
Pull Request resolved: https://github.com/facebook/flipper/pull/585

Test Plan: eyes

Reviewed By: jknoxville

Differential Revision: D17908742

Pulled By: passy

fbshipit-source-id: 81e3ccf9e1b94bd57d162dd59b0a4dfb8e4366ea
2019-10-15 02:31:10 -07:00
Pascal Hartig
4bdccb22fa Enable greenkeeper
Summary:
Close https://github.com/facebook/flipper/pull/580

This enables Greenkeeper with some caveats:

- I disabled a bunch of upgrades we know currently break:
  - React
  - Emotion
  - Electron/Electron-Builder
- The bot isn't CLA-whitelisted yet, so we won't be able to directly import yet.
- It might actually be better to have automatic tasks created for the dependencies above breaking.
- Something changed in the prop types and required `StatusBar` to have its signature changed.

allow-large-files

Reviewed By: jknoxville

Differential Revision: D17906693

fbshipit-source-id: f73fe231518f56a6f6114f761d5e5e5528d0d487
2019-10-14 09:42:56 -07:00
Pascal Hartig
96f5a87867 Docs for building windows/linux standalone apps
Summary: Closes https://github.com/facebook/flipper/pull/545

Reviewed By: jknoxville

Differential Revision: D17315711

fbshipit-source-id: 9ea02b50a76eb175d8df49577c45905799295233
2019-09-11 08:22:26 -07:00
Pascal Hartig
96d9c9638c Update README.md (#541)
Summary:
Fix indentation for the ToC
Pull Request resolved: https://github.com/facebook/flipper/pull/541

Reviewed By: danielbuechele

Differential Revision: D17257799

Pulled By: passy

fbshipit-source-id: 7ac402f4cadd287536f3f25578116084316831fc
2019-09-09 06:38:35 -07:00
Pascal Hartig
f2986f8a2f Update README.md (#465)
Summary:
Trying to address https://github.com/facebook/flipper/issues/464.
Pull Request resolved: https://github.com/facebook/flipper/pull/465

Reviewed By: danielbuechele

Differential Revision: D15778823

Pulled By: passy

fbshipit-source-id: 5bddd7914575fe5a53b53b6a7aee11e4777d9f57
2019-06-12 04:31:10 -07:00
Pascal Hartig
cdd733463a Add Cocoapods README badge
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/434

Reviewed By: jknoxville

Differential Revision: D15238279

Pulled By: passy

fbshipit-source-id: a5bd6bf45d0a9cd64d37de9c7c732c6b66403ee8
2019-05-07 11:24:42 -07:00
Pascal Hartig
a0fba743a1 Add Android download badge (#428)
Summary:
Quite useful if you want to know what the most recent version is.
Pull Request resolved: https://github.com/facebook/flipper/pull/428

Reviewed By: jknoxville

Differential Revision: D15164635

Pulled By: passy

fbshipit-source-id: 4a78b928625d6d71381b0e3e8272372f5f1b654d
2019-05-01 04:34:51 -07:00
John Knox
b1c735c40d Modify recommended ios build commands (#296)
Summary:
This will make sure your local pods repo is up to date, so you won't be building against old dependencies.
Pull Request resolved: https://github.com/facebook/flipper/pull/296

Reviewed By: passy

Differential Revision: D10446899

Pulled By: jknoxville

fbshipit-source-id: 61c8832e8d5f7c54a43fc3e419347687756f4883
2018-10-22 03:40:51 -07:00
Marc Terns
c7ad49a9eb Integrating NSUserDefaults plugin to iOS (#291)
Summary:
I have a few details left, but its almost done. This PR addresses #145

- The NSUserDefaults plugin uses the SharedPreferences Desktop Part since we can reuse all of it.
- The NSUserDefaults plugin uses swizzling in order to be notified of what specific event changed at runtime.
- Added Test harness in both Sample Swift and Sample apps for iOS in order to test the plugin.
- Updated the documentation in `docs/shared-preferences-plugin.md` and` README.md`

I am open to suggestions since the desktop sharedPreferences version doesn't support deletion of preferences. Most likely I would have to modify the UI, and for that matter, I might as well build a user defaults desktop version

I wanted to add xiphirx in this MR since he developed the shared preferences plugin for Android and Desktop. I don't see a way to remove preferences from the flipper desktop app so I was wondering if you would be OK with me adding that.
Pull Request resolved: https://github.com/facebook/flipper/pull/291

Reviewed By: passy

Differential Revision: D10334685

Pulled By: priteshrnandgaonkar

fbshipit-source-id: d798c01a46df7ddecf713924799f046b560ea922
2018-10-12 04:09:29 -07:00
Pascal Hartig
0a8eef466b Remove rename warning (#285)
Summary:
We're in a pretty good state now. Let's get rid of the big warning.
Pull Request resolved: https://github.com/facebook/flipper/pull/285

Reviewed By: jknoxville

Differential Revision: D10161261

Pulled By: passy

fbshipit-source-id: ef1fc03c289a0472916c67bf34c2f9e394c3fef2
2018-10-03 05:27:33 -07:00
Pascal Hartig
42ce5d992a Add docusaurus note to README
Summary:
Took me a moment to figure out how to build it,
so let's add it to the docs.

Reviewed By: jknoxville

Differential Revision: D9654631

fbshipit-source-id: 32ee6e647d9fa85b921d19919c1bbd060615bb8e
2018-09-05 08:13:31 -07:00
fvonhoven
decde229b6 Update README w/TOC & link Contributing & MIT sections (#222)
Summary:
* Add a Table of Contents to README
* Link CONTRIBUTING section to CONTRIBUTING.md file
* Link License section to LICENSE file
* Change `Sonar` references to `Flipper` in CONTRIBUTING.md

![flipper-readme](https://user-images.githubusercontent.com/10098988/43982318-f201c870-9cba-11e8-90b7-ebc47854e641.gif)
Pull Request resolved: https://github.com/facebook/flipper/pull/222

Reviewed By: danielbuechele

Differential Revision: D9282868

Pulled By: passy

fbshipit-source-id: 2f1ff9b598b8a0afdde9039e5a2c4a157c48ed9c
2018-08-13 03:42:30 -07:00
Pascal Hartig
75af6b3c72 Update README formatting (#208)
Summary:
Without the newline, this gets interpreted as a headline, which looks a bit weird.

Pull Request resolved: https://github.com/facebook/flipper/pull/208

Reviewed By: danielbuechele

Differential Revision: D9194566

Pulled By: passy

fbshipit-source-id: 67d63e072f4f8d0e86f3a2a0a48886e7e5716b40
2018-08-07 06:57:04 -07:00
Pascal Hartig
6bfdb8d114 README: Sonar -> Flipper
Summary: Kick off the rename.

Reviewed By: jknoxville

Differential Revision: D9044214

fbshipit-source-id: 86e7b3aeef8c972f18499185c291867751068a2d
2018-07-31 09:56:15 -07:00
John Knox
e0f8d1f89a Add basic build steps to README.md (#185)
Summary:
For those not familiar with android and iOS development practices, adding basic build instructions.
Pull Request resolved: https://github.com/facebook/Sonar/pull/185

Reviewed By: passy

Differential Revision: D8991468

Pulled By: jknoxville

fbshipit-source-id: 990dc1217c7b5275d143b915c1b4872b271f4c94
2018-07-26 03:32:58 -07:00
Pascal Hartig
540776f172 Add Travis link to readme (#141)
Summary:
![](https://media1.giphy.com/media/vntyBKuV7FwZO/giphy.gif)
Pull Request resolved: https://github.com/facebook/Sonar/pull/141

Reviewed By: jknoxville

Differential Revision: D8766655

Pulled By: passy

fbshipit-source-id: 04026f06d248880e5373806769613e9226aa712f
2018-07-09 07:19:22 -07:00
Hilal Alsibai
2a46f93eab Fix install for Windows (#138)
Summary:
This lets `yarn` work properly on Windows. Tested in a Cygwin environment. I also added a note about yarn compatibility to the readme.
Closes https://github.com/facebook/Sonar/pull/138

Reviewed By: danielbuechele

Differential Revision: D8734197

Pulled By: xiphirx

fbshipit-source-id: 19be8bb0653a2b0381224b065df0cac579d72c3b
2018-07-05 03:32:30 -07:00
Pritesh Nandgaonkar
49c533ed35 Travis badge (#135)
Summary:
Adds travis badge
Closes https://github.com/facebook/Sonar/pull/135

Reviewed By: danielbuechele

Differential Revision: D8732766

Pulled By: priteshrnandgaonkar

fbshipit-source-id: 51ba49b0382f9bef88f297d061e30c862b751cd1
2018-07-04 11:33:36 -07:00
Pascal Hartig
0768c9a43a Add Electron link to README
Summary:
Resubmit D8378726. Previous import stalled.

Closes #18

Original Author: alexeykuzmin

Reviewed By: jknoxville

Differential Revision: D8510131

fbshipit-source-id: 732318b919f00d16c2f7fc2385bae7bf11411085
2018-06-19 04:45:39 -07:00
Igor Randjelovic
0984103696 Add screenshot to the readme (#46)
Summary:
To make it more appealing for people landing on the GitHub page - seeing a nice screenshot is always a plus!
Closes https://github.com/facebook/Sonar/pull/46

Differential Revision: D8476809

Pulled By: danielbuechele

fbshipit-source-id: d26b10069ab5745342156669ff627dd4fdad2fdb
2018-06-18 03:32:10 -07:00
Daniel Büchele
50490b9435 Linux and Windows builds
Summary:
Adds windows and linux builds to Sandcastle

allow-large-files

Reviewed By: jknoxville

Differential Revision: D8379581

fbshipit-source-id: 94c80fc91c69f43b7dc0c7eb8b2ee5ace4daf888
2018-06-13 09:04:04 -07:00
Daniel Buchele
e6f1e3f018 website content updates 2018-06-07 14:19:23 -04:00