Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.43 KB

Contributing

Set up environment

  1. Install node
  2. Install yarn
  3. (optional) install VSCode to get recommended extensions.
  4. Prepare repository 
    git clone github.com/akuukis/sepraisal.git
cd sepraisal
yarn bootstrap
cp .env.example .env
  5. Edit .env file (comments inside)
  6. Read further any of READMEs of specific module
    • app is the web application. You most likely want to start here.
    • storybook are the stories of app. This is the easiest thing to get up and running.
    • cli are the scripts to do the backend thing: fetch and praise blueprints, update database.
    • praisal is where all the praisal logic lives. Feel free to use in your own projects.
    • common defines data model and blueprint classes that's used everywhere.

Note: As I'm developing on Linux machine only, I may have forgotten some cross-compatibility and it may not work out as smooth for Windows users. In that case, just open a issue or even better add PR if you know how to fix that.

Storybook

I used storybook at the beggining, but lately it got abadonded. If you wish to revive it, it shouldn't be that hard. Revert merge remove-storybook, and start from there.