Atlas business intelligence library plugs in to your existing reporting platforms, extracts useful metadata, and displays it in a unified report library where you can easily search for, document, and launch reports.
## ๐ Getting Started
> Atlas BI Library is built with [.Net 8.0](https://dotnet.microsoft.com/download/dotnet/8.0) and [Node](https://nodejs.org/en/download/). \
> Aside from those installs you will need to install ef core tools `dotnet tool install -g dotnet-ef`. \
> These guide can be run with [Visual Studio Code](https://code.visualstudio.com/download) and the built in terminal.
- Get the code `git clone git@github.com:atlas-bi/atlas-bi-library.git`
- Install the project dependencies `npm install` and `npm run dotnet:restore`
- Create an `appsettings.cust.json` and `appsettings.cust.Development.json` as specified in the [docs](https://www.atlas.bi/docs/bi-library/deploy/configuration/)
- Initialize the database and create tables `npm run db:update`
- Run the [ETL](https://www.atlas.bi/docs/bi-library/deploy/configuration/), or just insert your account name into the `dbo.[User]` `username` column.
- Finally, start up the website `npm start`
> If this is your first time running a dotnet webapp, you will need to trust the cert with `dotnet dev-certs https --trust` \
> Running `npm start` will build all the resources needed, start IISExpress, and then open your browser. \
> Debugging code is simple. In Visual Studio Code, simply press `f5` to activate breakpoints. Saving any file will trigger a rebuild.
## ๐งช Testing
Tests require two global dotnet tools.
```bash
dotnet tool install -g coverlet.console
dotnet tool install -g dotnet-reportgenerator-globaltool
```
- Install dependancies `npm install` and `npm run dotnet:restore`
- Run tests `npm run test:dev`
A hit/miss html report will be in the folder `/coverage`.
## ๐ Deploy to IIS
Build the release with `npm run dotnet:publish`.
Copy the output of `/out` to the folder of your IIS site.
See the [docs](https://www.atlas.bi/docs/bi-library/) for aditional configuration and starting search.
## ๐ Contributing
Contributions are welcome! Please open an [issue](https://github.com/atlas-bi/atlas-bi-library/issues) describing an issue or feature.
This repository uses commitizen. Commit code changes for pr's with `npm run commit`.
## ๐ Credits
Atlas was originally created and made open source by the Riverside Healthcare Analytics team. See the [credits](https://www.atlas.bi/about/) for more details.
## ๐ง Tools
Special thanks to a few other tools used here.
[](https://sonarcloud.io/summary/new_code?id=atlas-bi_atlas-bi-library)
[](https://sonarcloud.io/summary/new_code?id=atlas-bi_atlas-bi-library)
[](https://sonarcloud.io/summary/new_code?id=atlas-bi_atlas-bi-library)
/ Atlas
[](https://sonarcloud.io/summary/new_code?id=atlas-bi_atlas-bi-library)
[](https://sonarcloud.io/summary/new_code?id=atlas-bi_atlas-bi-library)
[](https://sonarcloud.io/summary/new_code?id=atlas-bi_atlas-bi-library)