Quickstart - PascalHonegger/HeyImIn GitHub Wiki

Quickstart

This document describes how to get an development environment up and running.

Used technologies

The frontend is an Angular web app which handles the main interaction with the user. The backend is an ASP.NET Core web service which provides an API for accessing the database. The database can be any technology, but for simplicity this project uses a Microsoft SQL server.

Used tools

  • The backend requires the latest .NET Core SDK
  • The frontend is compiled using Node.js
  • The notification system uses SendGrid - A developer test account is required if you want to be able to send notification emails
  • It is recommendend to use the most recent Visual Studio 2017 and Visual Studio code releases. Other tools might be used, but the IDE experience might not be ideal

Running the project

  • Frontend (run in the Frontend directory)
    • Development server: npm start
    • Generate production build: npm run deploy
  • Backend (run in the Backend directory)
    • dotnet run --project WebApplication
    • Selecting and starting the WebApplication project from Visual Studio
  • Database
    • Should be run automatically using Visual Studio

Configuration

How to specify configuration values and which options are available is described in detail in it's own configuration page.

Helpful links