DataCite Assets Server

The DataCite Assets Server. Uses the middleman static site generator.

Local development

Note: does not work with Ruby 3.x+ or Node 15.x+ . To run locally without installing older versions of Ruby/Node, follow the Docker steps

Run directly on your OS

Prerequisites

• Git
• Ruby v2.6
• RubyGems
• Node.js v14.x
• Bundler
• Yarn Classic

Install and start

1. git clone <repository-url> this repository
2. cd assets
3. yarn install
4. bundle exec middleman server
5. Visit the app at http://localhost:4567

Run in Docker

Prerequisites

• Git
• Docker desktop

Install and start

1. git clone <repository-url> this repository
2. cd assets
3. docker-compose up -d
4. Visit the app at http://localhost:4567

Build the Static Site

1. git clone <repository-url> this repository
2. cd assets
3. yarn install
4. bundle exec middleman build -e production

Find the static site in the ./build directory.

Issues

Follow along via Github Issues.

Notes on Patches/Pull Requests

• Fork the project
• Write tests for your new feature or a test that reproduces a bug
• Implement your feature or make a bug fix
• Do not mess with version or history
• Commit, push and make a pull request. Bonus points for topical branches.

License

Assets is released under the MIT License.