Getting started with Miunie
These instructions are going to walk you through downloading a copy of Miunie and running it.
🔧 If you want to know how to setup your environment for development, see this guide.
ℹ️ Checkout our deployment section for notes on how to set the project up for hosting on a dedicated machine.
- IDE / Code Editor
For picking which IDE to use, take a look at the following table.
- ⭐ - Recommended for a given platform
- ⚠ - Known issues for a given platform
- ✅ - Will work for a given platform
If you are a beginner, we suggest sticking to the ⭐ recommended options.
| Miunie.ConsoleApp | Miunie.WindowsApp | Miunie.AspNet | |
|---|---|---|---|
| Visual Studio 2019 (Community) | ⭐ | ⭐ | ⭐ |
| Visual Studio Code | ✅ | ❌ | ⚠ |
| Rider: The Cross-Platform .NET IDE | ✅ | ❌ | ✅ |
- Visual Studio Prerequisites
During the installation process of Visual Studio, you should always include the following options:
If you would like to build the ASP.NET project, include the following option:
If you would like to build the Universal Windows Platform App, include the following option:
- Ensuring .NET Core 3.1 (or higher) is installed
To make sure you have the correct version of .NET Core, open your command promt/Terminal/Powershell and type in the following command:
dotnet --list-sdks
Here is an example of this command's output on Windows:
3.1.101 [C:\Program Files\dotnet\sdk]
Your output may differ a bit, however as-long as you have 3.1 installed then you're good to continue.
If you see a version higher or equal to 3.1, you can continue to the next step.
If you don't see the right version or if you got a response similar to Command not found, you need to download an install the latest version of .NET Core.
You can install it here.
- Getting a copy of the project
If you want to clone or fork this repository instead, please follow the contributing guide.
Download the project by pressing the green "Clone or download" button and selecting the "Download ZIP" option.
Unzip the directory and navigate into the src folder inside it.
Open the Miunie.sln in your IDE.
🎉 Congratulations, you are now set up for building and running Miunie.
If you need more information about how to build and run the project, please contact us on our Discord server:
