@bcredi/bcredi-widget

bcredi-widget

New Bcredi simulator, made with preact

how contribute

1. Clone project locally.
2. Sync your local copy before you branch.
3. Branch for each separate piece of work.
4. Do the work, write good commit messages.
5. Push to your origin repository.
6. Create a new PR in GitHub, assign yourself and request a codereview.
7. Respond to any code review feedback.

First of all, you need to download the packages, so, just call:

$ npm i

how to start a local server

To run locally:

$ npm run dev

A server on port 8080 will be started. Just go to http://localhost:8080.

how to build the project

$ npm run build

This command will build project and create a folder called "build", placing inside it all files you will need to run the project in production.