Frontend application the provides the search UI on top of the ROR API used in https://ror.org/search .
You will need the following item properly installed on your computer.
- Git
- Node.js (with npm)
- Ember CLI
- Google Chrome
- ror-site information site
git clone <repository-url>this repositorycd ror-appyarn install
-
Start ror-site per instructions in https://github.com/ror-community/ror-site . ror-app shares core CSS with ror-site
-
Create a file
.envand add the following environment variables to it. Optionally, you can include LAUNCH_DARKLY_CLIENT_SIDE_ID if you are using Launch Darkly feature flags. API_URL=https://api.ror.org (optionally, use localhost:9292 to develop against ror-api running locally in Docker) BASE_URL=http://localhost:1313 -
ember serve -
Visit your app at http://localhost:4200.
-
Visit your tests at http://localhost:4200/tests.
Make use of the many generators for code, try ember help generate for more details
ember testember test --server
npm run lint:hbsnpm run lint:jsnpm run lint:js -- --fix
ember build(development)ember build --environment production(production)
- All development should be done locally in feature branches.
- When you have changes ready to push to dev, open a pull request against the dev branch.
- Do not push changes directly to dev or master.
Deployment is handled by Github actions
- Deploy Dev action deploys to dev.ror.org on push/merge to dev branch
- Deploy Master action deploys to ror.org on push/merge to master branch
Core CSS hugo-ror.css is shared between ror-app and ror-site and is hosted on ror-site, https://ror.org. SCSS file is located at https://github.com/ror-community/ror-site/blob/master/themes/hugo-ror/assets/sass/partials/_hugo-ror.scss.
The BaseUrl environment variable is used to point to hugo-ror.css for the corresponding environment (dev, staging, prod) in the head of index.html. See above for local dev instructions.