Getting Started!

In just a few minutes you can have Atlas Library web app running on your computer.

∞ Required Tools

There are a few build tools required to get started. The .Net version of Atlas Library is intended to run on Windows PC’s that are connected to a domain.

• Git
• Python
• (optional) Poetry python package manager
• Windows Build Tools
• Java
• SQL Server ODBC
• Node.js + NPM
• Microsoft .NET SDK 8
• Visual Studio Code (For building the website)
• [Visual Studio 2019] (For building the ETL’s)(https://visualstudio.microsoft.com/vs/older-downloads/)
• Visual Studio SQL Server Integration Services

Clone the project form GitHub into a new Visual Studio Code project using the clone url: https://github.com/atlas-bi/Library.git

Create a file called web/appsettings.cust.Development.json with a database connection string. Localdb is an easy way to get started. For a production website you should use a database on a real instance of sql server.

{
  "ConnectionStrings": {
    "AtlasDatabase": "Server=(localdb)\\mssqllocaldb;Database=atlas_test;Trusted_Connection=True"
  }
}

Next, install the dependencies. Open a powershell terminal session in VS Code.

npm install

Then, migrate the database. This command will build the application and then create/update the database with all the tables needed. A lot of green and white text will print out… finally telling you “Done.”!

npm run db:update

Finally, start the website. This command will build all the resources needed to start the site. It will open a browser automatically. After the browser opens give it a few more seconds to finish initializing .Net, then refresh the browser. You will see lot of white and purple text coming from Hangfire and EntityFramework when the app is ready to roll.

npm start

# alternatively, if you would like to run a a dev saml and solr instance
npm run dev

You should see yourself logged in as an admin with a name Guest! Next you can run the ETL’s to load in some report data!