utterance/utterances
1
1
Fork 0
mirror of https://github.com/utterance/utterances.git synced 2024-07-07 04:06:22 +03:00
Code Issues Projects Releases Wiki Activity
master
utterances/CONTRIBUTING.md
Jeremy Danyow b2dac0f6fe
fix typos
2019-01-27 17:22:06 -08:00

828 B
Raw Permalink Blame History

Contributing

  1. Install yarn: https://yarnpkg.com
  2. Clone the repo: 
    git clone https://github.com/utterance/utterances
  3. Install the project's dependencies using yarn: 
    cd utterances
yarn install
  4. Start developing! 
    yarn start
    This command compiles the source files and starts a development webserver. Any change you make to the source TypeScript, HTML and SCSS files will automatically be recompiled. Go to http://localhost:4000/index.html to view your changes.

Theme Development

Each theme is located in a subdirectory of src/stylesheets/themes. Themes must have an index.scss and utterances.scss files. These are the entrypoint stylesheets for the utterances homepage and utterances widget respectively. Todo: more instructions