This is the prototype of the upcoming OSF preprints. This guide will help you get started if you're interested.
You will need the following things properly installed on your computer.
npm install
bower install
For local development, this is designed to run alongside (and from within) the flask application for osf.io.
- Check out this OSF feature branch: https://github.com/CenterForOpenScience/osf.io/tree/feature/ember-preprints
- Start your Ember server:
ember serve
- Copy these lines
to your
website/settings/local.py
file. Uncomment'/preprints/': 'http://localhost:4200',
and restart your flask app. - Visit your app at http://localhost:5000/preprints/
If you encounter problems, make sure that your version of ember-osf is up to date. If login fails, try logging in from any other OSF page, then returning to the preprints app.
There are a few scripts to run to populate your local preprint providers list, and help generate some "fake" preprints locally so you can begin testing using the OSF API.
- Populate the OSF's PrerpintProvider model with data:
python -m scripts.populate_preprint_providers
- Populate the OSF's Subject model with data:
python -m scripts.update_taxonomies
- Create "fake" preprints using some additional arguments to the
create_fakes
script:
python -m scripts.create_fakes -u [email protected] --nprojects 2 --preprint True --preprintprovider osf,psyarxiv
notes: You can enter as many providers as you like, seperated by commas. Also, this script does not currently create actual fake files, only fake file metadata; the file itself won't render in a preprint view, but you can still request its information from the API.
Make use of the many generators for code, try ember help generate
for more details
ember test
ember test --server
ember build
(development)ember build --environment production
(production)