The PET Group

DeskMotion for desk stuff.
View Project »

Issues · Board

Getting Started 🚀

Installation:

1. Download the latest release from releases.
2. Follow the installation guide provided with the release.

Running with Docker 🐳

1. Set up your .env file:

   • Copy the example.env file to .env in the project root:

     cp example.env .env

2. Run the application:

   docker compose up --detach --build

Trusting Dev HTTPS Certificates (Optional) 🛡️

1. Open the terminal in the project root and trust the HTTPS certificate:
   • Note: You MUST close all the entire browser for it to take affect.

   dotnet dev-certs https --trust -ep certs/LocalhostDevCert.pfx -p postgres

Will be replaced by a real Cert from Let's Encrypt in Production.

Updating Migrations in the Asp.NET Project 🖱️

If you make changes to the application database context, follow these steps to update the migrations:

1. Delete the Migrations folder in the project directory.
2. Run the following command in the Razor Pages project directory:

   dotnet ef migrations add InitialCreate

This will create a new initial migration reflecting the changes to the database context.

Contributing 🤝

1. Clone Open GitHub Desktop, go to File > Clone Repository, and enter:

   https://github.com/SP-SDU/DeskMotion
   

2. Branch: In GitHub Desktop, switch to main and create a new branch (e.g., add-login-feature).
3. Commit & Push: Commit changes in GitHub Desktop, then click Push origin.
4. Pull Request: Open a pull request on GitHub, choosing main as the base branch, and tag a teammate for review.

For more details, see GitHub Flow.

Communication 🗂️

Join the Discord server for discussions and updates.

License 📝

Distributed under the Apache 2.0 License. See LICENSE for details.