https://github.com/centerforopenscience/ember-osf-web

Ember front-end for the Open Science Framework
https://github.com/centerforopenscience/ember-osf-web

ember javascript openscience osf science

Last synced: 7 days ago
JSON representation

Ember front-end for the Open Science Framework

• Host: GitHub
• URL: https://github.com/centerforopenscience/ember-osf-web
• Owner: CenterForOpenScience
• License: apache-2.0
• Created: 2017-09-14T18:25:41.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2025-01-17T16:06:44.000Z (7 days ago)
• Last Synced: 2025-01-17T16:49:06.090Z (7 days ago)
• Topics: ember, javascript, openscience, osf, science
• Language: TypeScript
• Homepage: https://osf.io
• Size: 41.6 MB
• Stars: 120
• Watchers: 14
• Forks: 56
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ember-osf-web

`master build`

    





    



`develop build`

    





    



A front end for [osf.io](https://github.com/CenterForOpenScience/osf.io).

## Prerequisites

You will need the following things properly installed on your computer.

* [osf.io back end](https://github.com/CenterForOpenScience/osf.io)

* [Git](https://git-scm.com/)

* [Node.js](https://nodejs.org/) (with NPM)

* [Ember CLI](https://ember-cli.com/)

* [Watchman](https://facebook.github.io/watchman/)

## Installation

* `git clone https://github.com/CenterForOpenScience/ember-osf-web.git`

* `cd ember-osf-web`

* `yarn --frozen-lockfile`

## Running / Development

### Mac OS File Descriptor Limits

Watchman [states](https://facebook.github.io/watchman/docs/install.html#mac-os-file-descriptor-limits) "*Only applicable on OS X 10.6 and earlier*". Though it's been observed this setting can remain incorrect on systems where the operation system was upgraded from a legacy version.

> Putting the following into a file named /etc/sysctl.conf on OS X will cause these values to persist across reboots:

```bash

kern.maxfiles=10485760

kern.maxfilesperproc=1048576

```

### Development

Configure the application for local development, add the following to your `config/local.js`:

```ts

module.exports = {

    // an ally audit can use 100% of your browsers cpu, so use it wisely

    A11Y_AUDIT: false,

    // toggle on/off the engine applications you will be working on

    COLLECTIONS_ENABLED: false,

    // sourcemaps are useful if you need to step through typescript code in the browser

    SOURCEMAPS_ENABLED: true,

};

```

* `ember serve`

* View the ember app (alone) at [localhost:4200](http://localhost:4200)

To integrate with the legacy front end at [localhost:5000](http://localhost:5000), you have two options:

* Enable the waffle flags for each page in your [local OSF Admin](http://localhost:8001/admin/waffle/flag)

* Add routes to your `osf.io/website/settings/local.py`:

    ```py

    EXTERNAL_EMBER_APPS = {

        'ember_osf_web': {

            # ...

            'routes': [

                'handbook',

                'dashboard',

                # ...

            ],

        },

        # ...

    ```

### Code Generators

Make use of the many generators for code, try `ember help generate` for more details

### Running Tests

* `ember test`

* `ember test --server`

### Linting

* `yarn lint`

* `yarn lint:fix`

### Building

* `ember build` (development)

* `ember build --environment production` (production)

## Further Reading / Useful Links

* [ember.js](http://emberjs.com/)

* [ember-cli](https://ember-cli.com/)

* Development Browser Extensions

  * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)

  * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)