node (6.x lts)
// installing node 6.x lts using homebrew on macOS
brew install node@6
// centos
curl --silent --location https://rpm.nodesource.com/setup_6.x | bash -
yum -y install nodejs
// for more detail https://nodejs.org/en/download/
redis (3.2+) http://redis.io/ or
brew install redis
git clone --recursive https://github.com/PATRIC3/p3_web.git
cd p3_web
npm install
cp p3-web.conf.sample p3-web.conf (and edit as necessary)
If you cloned without --recursive flag,
cd p3_web
npm install
git submodule update --init
// Note: git submodule fetches a module in node_modules directory. So npm install first!
In ./p3-web.conf, place a token and user id/name as follows:
{
"devAuthorizationToken": "token",
"devUser": {
"id":"user@patricbrc.org",
"name": "user name"
}
}Note: authentication is stored as a session cookie. You can clear it via your browser devtools if needed.
redis-server &
npm start
Note: if any configuration changes are made (i.e., changes to ./p3-web.conf), then ./bin/p3-web must be restarted.
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -m 'Add some feature - Push to the branch:
git push origin my-new-feature - Submit a pull request
// if needed, create an 'upstream' remote with 'git remote add upstream https://github.com/PATRIC3/p3_web/'
git fetch upstream
git submodule update --init
git merge upstream/master
Read more here here.
Although a build a is not explicitly required to make a PR, it's a good idea to ensure your code will build.
Before creating a build, sync your fork with the master of PATRIC3/p3_web as above.
The following will create a build in ./public/js/release:
./buildCLient.sh
Note: jBrowse is currently causing some havoc in builds. You can 'fix' this by commenting out xstyle/load-css in ./public/js/JBrowse/main.js.
Increment the version in ./package.json, following the semantic versioning specification, and commit the new build:
edit ./package.json // increment "version"
git add --all
git commit -m 'release js'
git push
Note: version is where the build is deployed and what is displayed in the UI.