readme.md

/ Atlas

<style> .text {font:16px sans-serif; user-select:none;fill:rgb(51 65 85)} .slash {font:20px sans-serif; user-select:none;fill:rgb(203 213 225)} .slash:hover, *:hover > .slash {fill:rgb(14, 165, 233);} </style> / library

https://avatars.githubusercontent.com/u/90376906?s=400&u=7592339d75e23b1e5b5db486c48271f6491d1422&v=4

Atlas BI Library | The unified report library.

Website • Demo • Documentation • Chat

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 and Node.
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 and the built in terminal.

• Get the code git clone [email protected]: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
• Initialize the database and create tables npm run db:update
• Run the ETL, 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.

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 for aditional configuration and starting search.

🎁 Contributing

Contributions are welcome! Please open an issue 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 for more details.

🔧 Tools

Special thanks to a few other tools used here.