Table of Contents
Environment setup and usage
This page is an introduction on how to setup the coding environment and how to develop in it.
Setup
First of all, you should clone the repo. Either via Git CLI or a Git GUI, both works fine. Clone the project to a directory of your choosing with:
git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
as
git clone https://git.webug.se/Andras/BoundlessFlowCampus2K.git
or use the GUI (it should be straightforward with the visual aid the GUI gives).
With all dependencies you should be able to run the installation script, located in ./scripts, to update and add some packages to have all the functionality the project requires.
Please read the README in the scripts directory as it provides useful information about how and when to use the script to ease your development.
If the script doesn't error everything should be fine and the process of building/running the environment can be started.
Running
Running the environment is also done via a script, specifically the Rebuild script. The README explains when to use this, but the short version is to run this script now to start the environment. If this doesn't error the environment should be setup and ready to use.
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