Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplify developer onboarding #111

Merged
merged 1 commit into from
Jun 29, 2017
Merged

simplify developer onboarding #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,18 +124,13 @@ ScienceFair also follows a few simple design principles that we feel are missing

## development

This project uses node `v7`, ideally the latest version. It also uses the two-`package.json` structure ([what??](https://github.com/electron-userland/electron-builder/wiki/Two-package.json-Structure)).
This project uses node `v7`, ideally the [latest version](https://nodejs.org/dist/latest-v7.x/). It also uses the two-`package.json` structure ([what??](https://github.com/electron-userland/electron-builder/wiki/Two-package.json-Structure)).

To get a local copy working:

Clone this repo, then run
To get a local copy working, clone this repo, then run

- `npm install` to install dev dependencies
- `cd app && npm install && npm run rebuild` to install regular dependencies

cd back to the root of the repo and run

- `npm run dev` to start in development mode
- `cd .. && npm run dev` to start in development mode

## roadmap

Expand Down