Setup for Mac
Note that: Visual Studio Code is not a requirement per say, but is strongly recommended as a common code editor for this project. If you feel like using something else you are free to do so, but be aware that this can cause issues/headaches. Also be sure to add any unwanted files or directories that your code editor might create to the .gitignore file, as to not clutter the project.
OS specific links to downloading dependencies:
Visual Studio Code (VSC)
- Download VSC and open the .dmg file.
- Drag VSC to the Applications folder.
- Launch Visual Studio Code.
- Install required extensions:
- Select extensions (Or use ⇧⌘X (Shift + Command + X)) and install "C# Dev Kit".
If you have come this far, you have verified that VSC works.
Docker
Download the installer and follow the installation instructions.
To verify that it works, open your favorite CLI and use:
docker --version
docker compose version
It works correctly if these return version numbers.
Node
Download and run the installer. Be sure to not install it using Docker (it's an option in the installer).
To verify that it works, open your favorite CLI and use:
node --version
npm --version
Dotnet
Download and run the installer (be sure to pick SDK 10.0)
Note: Make sure to choose the SDK version 10.0
To verify that it works, open your favorite CLI and use:
dotnet --info
Git
With Git you have two options. Either you can use the Git CLI to do everything, or you can use a GUI for your Git. In this project we strongly recommend using a GUI as it is easier. We specifically recommend GitHub Desktop. But both installations will be covered below.
Git CLI
On MacOS, Git is packed alongside Xcode, meaning that you might already have it installed. Verify it first by opening your favorite CLI and use:
git --version
If it doesn't return a version number, you can install Git with:
xcode-select --install
or any other way Git's offical site recommends.
GitHub Desktop
GitHub Desktop can be found here.
Run the installer. The Git CLI is installed as a part the GUI version and is thus verified the same way.
Continuation
Continue here for setup of the project environment.
1. Setup
2. Standards
- Coding Conventions
- Issues
- Branch creation
- Reviews
- Implementation Standards
- [WIP] Creating new databases
- Localization
3. Models and Diagrams
4. Testing
5. Documentation
- Documentation for service endpoints
- API documentation
- Webpage Design
- Secrets and .env
- Evaluations
- Installation and Rebuild script documentation
6. Guides and How-to's
7. Micro Service Mockup Api
- Guidelines Mircro Service Mockup
- Documentation of useTemperature/useTemperatureTimeSeries mockup sensor