tgeorgeux / new.jupyter.github.io

This is the playground for the new Jupyter.org. Expecte great, or at least slightly better than mediocre, things.
BSD 3-Clause "New" or "Revised" License
2 stars 4 forks source link

new.jupyter.github.io

This is the playground for the new Jupyter.org.

Here is a link to the style guide. We will build components based on this. https://www.figma.com/file/PQD2GrejGoeZdYGhXthnAuEs/jupyter_master?node-id=700%3A2322

See it running at https://guarded-sands-77993.herokuapp.com/

Contributing

  1. You can get started with npm install.
  2. We use TypeScript and React in this project.
  3. When developing: npm run dev to see it in action!
  4. For production: npm run build will generate production-ready HTML in dist/.
  5. We use ESLint, make sure to npm run lint-fix your code.
  6. For heroku, you can push to the Git remote https://git.heroku.com/guarded-sands-77993.git.

Tools

  1. You can use generact to make copies of existing React components.
  2. You can use the React Developer Tools Chrome extension to probe individual React components of the site.
  3. There is an ESLint VSCode plugin to show lint errors in the text editor. Make sure to add this to your settings.json:
    {
    "eslint.alwaysShowStatus": true,
    "eslint.autoFixOnSave": true,
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        {
            "language": "typescript",
            "autoFix": true
        },
        {
            "language": "typescriptreact",
            "autoFix": true
        }
    ]
    }