Made by Nhat K. Nguyen @ resolve Computing Services Co Ltd
This repository is made as a submission to the Sisense Compose SDK Hackathon.
Compose SDK is a software development kit from Sisense that enables a composable, code-driven way to use Sisense platform capabilities. The SDK consists of packages such as: sdk-ui, sdk-cli, sdk-data, etc.
Click here to visit the official documentation.
The app is named CompetiSense (get it?) - it has the feature to show overviews and insights of different workspaces using Sisense Compose SDK charts with some touch to different types of filters and style customization.
There are 2 available workspaces that you can toggle in the app: (1) eCommerce and (2) Custom Retail.
-
eCommerce: Using 'Sample ECommerce' (dataset that stores in Sisense environment): Recap and Insights.
- Pros: intended way to use compose SDK, has powerful tools (eg. measureFatory, filterFactory, etc.) to perform powerful data analytics while the dataset is handled in the Sisense environment.
- Cons: the filter tools though powerful in certain cases, aren't fully covered; the filter tile components (eg. MemberFilterTile, DateRangeFilterTile, etc.) need extra effort to style & customize compared to things like charts.
-
Custom Retail: Using custom data (dataset that doesn't go through Sisense environment): Overview, Retail and Employees.
- Pros: have the freedom to manipulate data at your own will (though it still needs to follow certain format in order to be used in compose SDK charts).
- Cons: can only utilize charts from sdk-ui; since the data doesn't go through Sisense environment, it can't use anything from powerful date format, measureFatory, filterFactory to MemberFilterTile, DateRangeFilterTile, etc.
After installing the required dependencies, create a .env or .env.local file in the root directory to store the credentials in order to use Sisense's resources. The example can be found in the file .env.local.example.
Afterwards, run the following command in the terminal to execute the program:
$ pnpm run dev # or yarn run dev, npm run dev, bun run dev, etc.It is required to include a detailed documentation of the project, particularly to show which, where and how Sisense Compose SDK is used within the built application. You can locate and download the document here. It contains descriptions, screenshots and hyperlinks pointing out the process of how the app was developed.