Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.
/ openspaceplanner Public archive

Open Space Planer for making open spaces more digital.

License

Notifications You must be signed in to change notification settings

AITGmbH/openspaceplanner

Repository files navigation

! This project wil go into an archived status and will no longer be maintained !

Open Space Planner

Build Status

Introduction

This tool allows you to plan, for example, fully packed conference days, which can contain any number of rooms, slots and so on. It offers an easy and fast handling both for the planner of the day and for the participants. Within a few clicks a new session is created, times and topic blocks are entered and the participants can register. After a topic participants can give feedback to the speaker.

Getting Started

After cloning the project:

  1. Install the .NET 7 runtime and .NET 8 SDK
    The .NET 7 runtime is required for the .NET tools.

  2. Install the NodeJS 20 SDK

  3. Restore tools and packages

dotnet tool restore
cd src/WebApi && dotnet restore
cd src/Website && npm ci
  1. Optional: Add Azure Storage Credentials (otherwise the data will be saved in a local file)
    dotnet user-secrets set TableStorageAccount <account>
    dotnet user-secrets set TableStorageKey <key>
    dotnet user-secrets set TableStorageContainer <container> (optional, otherwise the container will be named database)

Debugging

  1. Run cd src/Website && npm run start to build and run the frontend
  2. Run cd src/WebApi && dotnet watch run to build and run the backend
  3. Open the website at http://localhost:4200/
  4. Open the API at http://localhost:8080/swagger/

Creating API in frontend

The backend is exposing the API and models through OpenAPI. The frontend can automatically generate Angular services and TypeScript classes for those:

cd src/Website && npm run generate-openapi

Make sure to build the backend once for the swagger.json to exist. If you make changes to the backend also make sure to build the backend before generating the frontend code.

Gitpod

You can also open the solution in Gitpod: https://gitpod.io/#/github.com/aitgmbh/openspaceplanner/. The link to open the open space planner will be printed in the Backend terminal. You can also open the Remote Explorer in the menu on the left side to see the open ports. Click on the browser icon next to port 5000 to open the website.

About

Open Space Planer for making open spaces more digital.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published