Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 1.84 KB

README.md

File metadata and controls

37 lines (31 loc) · 1.84 KB
Raw

reddit-mobile

Build Status

reddit-mobile is a web server and build system for building polymorphic React applications in node. It is part of a larger series of plugins that, together, form frontend applications for reddit.

See the wiki for an in-depth explanation of how everything fits together.

Getting Up and Running

  1. Install node.js v4.2 and npm 3.5
  2. Fork and clone this project.
  3. Run npm install to install other dependencies.
  4. Run git submodule update --init to download this project's submodules.
  5. Run npm run build to build the assets (npm run watch to set up a filesystem watcher.)
  6. Register a new oauth application and set up your environment variables. Redirect URI should be http://localhost:4444/oauth2/token.
  7. Run npm start to start the web server. Optionally, create a startup script at start.sh that sets environment variables and starts the server; start.sh has been added to the .gitignore and will not get checked in.
  8. If you need to work on dependencies (snoode, horse-react, etc):
    1. Delete the dependencies you installed from ./node_modules
    2. Fork and clone the dependencies somewhere
    3. Run npm link within the dependency that you cloned
    4. Repeat recursively if you need to work on a dependency's dependency
    5. Re-run the build and restart your server (npm run watch will watch linked files)
  9. Commit hooks - symlink hooks into .git/hooks (ln -s -f ./hooks .git/hooks), which will run some safety checks before committing and pushing code.