⚠️ This repo is deprecated
The code in this repository was folded into Eigen. Please go there for all future development.
Reactions ⇒ Emissions
Inside Emission you will find:
- An example app for building and running Emission's components with an Eigen-like API.
- An NPM module that relies on React Native and manages the components.
- A Podspec that wraps it all together for easy external usage in Eigen.
- State: retired, see Eigen
- Point People: @ashfurrow, @ds300
git clone https://github.com/artsy/emission.git && cd emission && make setup && make oss
git clone https://github.com/artsy/emission.git && cd emission && make setup && make artsy. Then look in 1password for the Eigen keys.
- Install Node.js, and Yarn:
$ brew install node yarn
- Install file watcher used by React Native:
$ brew install watchman
- Install NPM modules:
$ yarn install
- Install Pods:
$ cd Example && bundle && bundle exec pod install
Ran into issues? Try troubleshoot.
Running the project:
$ yarn startfrom the top directory, which will:
- Clean the example app’s Xcode build dir.
- Start the example app’s React Native packager.
- Start the React Storybooks environment.
Now from Xcode you can run the app in
- If you already have the app installed, you can run
open -a Simulatorto open the last sim, and then
xcrun simctl launch booted net.artsy.Emissionto open the app.
- If you run into any issues with the above commands oftentimes a full clean can help. Run
rm -rf node_modules; rm -rf Example/Pods; yarn install; cd Example; bundle exec pod installand then repeat the steps above.
To create your React components and Relay containers, use the omakase generator. E.g.
$ yarn om g src/lib/Scenes/Artwork/ArtworkMetadata -f Artwork
$ yarn om g src/lib/Scenes/Artwork/ArtworkMetadata -r Artwork
$ yarn om g src/lib/Scenes/Artwork/ArtworkMetadata -p Artwork.artists
For full details see the CLI README.
Using VS Code as an IDE
There is a comprehensive document covering our setup here.
There is a comprehensive document covering the various options.
We vendor some data from other repositories that you will sometimes need to update. Notably the GraphQL schema of metaphysics that Relay uses to generate queries from:
$ yarn sync-schema
Deploys are automated on CI after each PR merge, based on the patch/minor/major label added to the PR (patch is default).
React Native Storybooks:
React Native Debugger:
This project is the work of engineers at Artsy, the world's leading and largest online art marketplace and platform for discovering art. One of our core Engineering Principles is being Open Source by Default which means we strive to share as many details of our work as possible.
You can learn more about this work from our blog and by following @ArtsyOpenSource or explore our public data by checking out our API. If you're interested in a career at Artsy, read through our job postings!