jeantil/pear-ui

A react based web ui for pear's API

Pear UI

This project is a web UI for the pear cfp backend

Contributing

Make sure you use the node version from .node-version. This project uses editorconfig and prettier to enforce a consistent style. Please make sure to configure your editor accordingly

Configuring your editor

VSCode

install

• EditorConfig for VS COde
• Prettier - Code formatter

They should pick up the style configuration automatically.

In some cases VsCode can fail to identify the files type as JavaScript React and use Javascript instead which will mess up the formatting of jsx templates. They should pick up the style configuration automatically. In some cases VsCode can fail to identify the files type as JavaScript React and use Javascript instead which will mess up the jsx formatting.

To avoid this go to Preferences: Open User Settings, in the user settings choose workspace settings and add the following:

    "files.associations": {
        "*.js": "javascriptreact"
    }

Developping locally

you can use the following commands:

• npm run start starts a development server with change monitoring and automatic reload
• npm run build builds the application into html/js/css and puts it in public/
• npm run test if you cannot guess, get in touch before you contribute :)