Giter VIP home page Giter VIP logo

ry-starter-spa's Introduction

Continuous Integration Discord Chat

This is heavily outdated

I mostly now use the NextJS starter.

( πŸ§˜πŸΏβ€β™€οΈ βΈ¬ πŸ§˜πŸ½β€β™‚οΈ | 🧘🏻 ) Single-Page-Application Starter

πŸŽ’ Preparations

Any real adventurer prepares their trip. For this trip you need to equip your computer with the following supplies:

πŸ–₯ Developing

We recommend using Storybook during development but you can also locally start the application.

πŸ“— Using Storybook

A very nice workflow for building frontends is to use Storybook. You write stories for your components and immediately see them in action. This frees you from having to click through your UI to finally find your component. It also frees you from having to simulate error states; you just write a story for that.

To run storybook run:

npx yarn storybook

πŸƒπŸ½β€β™€οΈ Running the whole application

To see the project in your browser run:

npx yarn start

πŸ§ͺ Testing

To run the tests issue this command

npx yarn test

πŸ›  Building

If you would like to create an HTML and a JavaScript file on your computer, this is how:

πŸŽ’Preparations

You need to equip your computer with Zephyr. If you have trouble with this, please open an issue on this Github Repository and we will help you!

πŸ“¦ Bundling

To create a bundle that is essentially an index.html and an index.js file run the following command:

npx yarn bundle

πŸ‘Ÿ Running

To run the bundle open the file ./dist/index.html in your favourite browser.

ry-starter-spa's People

Contributors

i-am-the-slime avatar dependabot[bot] avatar jans-fp avatar

Stargazers

Jay Palekar avatar Jihad D. Waspada avatar  avatar Jan Schulte avatar Andreas Thoelke avatar Pete Murphy avatar  avatar Leif Battermann avatar Isaias Bartelborth avatar

Watchers

James Cloos avatar  avatar Andreas Thoelke avatar

ry-starter-spa's Issues

storybook controls

Is it possible to get controls working for purescript components? I assume it normally uses propTypes or typescript definitions to figure it out, and I'm not aware of a way to generate either of these from a purescript component.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.