The Points module powers the loyalty points features of the Magic Batua platform.
-
Clone the repository to your computer.
-
Open Terminal (Command Prompt on Windows), cd
to the project folder and type npm install
.
This would install all the NPM dependencies for this project, and transpile the Typescript
code to JavaScript. Don't close the Terminal window.
-
Next, type the following in the Terminal window: npm test
. This would run all the unit test
that I've written for this particular module. If all tests pass, you've got a fully working
Account
module in front you.
-
To get a sense of the code structure, I'd recommend consulting the Code Manual
. Code Manual
is a local site that gets generated from the documentation comments I've left in the source code.
To generate Code Manual
on your computer, open the Terminal, cd
to the project root and run
npm run code-manual
.
-
You should now have a Code Manual
folder at your project root. Open the index.html
file in
the folder in your favourite browser and enjoy the ride.
-
Make sure you commit any changes made to the source code at regular intervals, and sync the changes
back to the Bitbucket origin
repository.