To contribute to this project or build everything locally, start by cloning the repository:
git clone https://github.com/cobrinhas/instagram-story-trackerAfterwards, install the client-side Git hooks to automatically format and lint the project before pushing new commits.
./hooks/INSTALLTo finish, install all the dependencies the project requires to be built.
npm i
If everything finished successfully, you're ready to start hacking around! The table below will onboard you on the available commands to use.
| Script | Description |
|---|---|
npm run build |
transpile and bundle files in .cjs, .js, .d.ts and respective source-maps |
npm run start |
run the project with swc compilation |
|npm run test|run the unit tests|
|npm run lint|analyze and lint the project|
|npm run format|format the project based on lint feedback|
|npm run docs|generate docs site|
|npm run docs:publish|generate docs site and publish it to GitHub Pages|