Cleaned up
This commit is contained in:
@@ -42,7 +42,7 @@ My.Dotenv.Plugin
|
||||
┗ 📜My.Dotenv.Plugin.csproj
|
||||
```
|
||||
|
||||
Rename the following files. Also rename the classes in these files, the easiest way in `vscode` is the right click the class name and select the `Rename symbol` action. Note that this action does not (necessarily) rename the files!
|
||||
Rename the following files. Also rename the classes in these files, the easiest way in `vscode` is to right click the class name and select the `Rename symbol` action. Note that this action does not (necessarily) rename the files!
|
||||
|
||||
```
|
||||
HelloWorldCommand.cs => DotenvCommand.cs
|
||||
|
||||
@@ -8,12 +8,18 @@ sidebar_position: 2
|
||||
|
||||
To use MycroForge, ensure you have the following dependencies installed:
|
||||
|
||||
- **bash**
|
||||
- **git**
|
||||
- **Python 3.10**
|
||||
- **Docker**
|
||||
- **.NET 8**
|
||||
- **XCode Command Line Tools (MacOS only)**
|
||||
- [**bash**](https://www.gnu.org/software/bash/)
|
||||
- [**git**](https://git-scm.com/)
|
||||
- [**Python 3.10**](https://www.python.org/downloads/release/python-3100/)
|
||||
- [**Docker**](https://www.docker.com/)
|
||||
- [**.NET 8**](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
|
||||
- [**XCode Command Line Tools (MacOS only)**](https://mac.install.guide/commandlinetools/)
|
||||
|
||||
## Prior knowledge
|
||||
|
||||
Since this tool is meant to generate FastAPI & SQLAlchemy code, you should have decent knowledge of both frameworks. If not, then please follow the links below to learn more about them.
|
||||
- [FastAPI](https://fastapi.tiangolo.com/)
|
||||
- [SQLAlchemy](https://www.sqlalchemy.org/)
|
||||
|
||||
### Adding the Package Registry
|
||||
|
||||
@@ -61,8 +67,12 @@ You can only add it to the current session by running the following command:
|
||||
export PATH="$PATH:/Users/username/.dotnet/tools"
|
||||
```
|
||||
|
||||
#### Known issues
|
||||
### Known issues
|
||||
|
||||
##### FastAPI swagger blank screen
|
||||
#### FastAPI swagger blank screen (MacOS only)
|
||||
|
||||
If you see a blank screen when opening the FastAPI Swagger documentation, then make sure you've activated the Safari developer tools.
|
||||
If you see a blank screen when opening the FastAPI Swagger documentation, then make sure you've activated the Safari developer tools.
|
||||
|
||||
#### Database container doesn't start after running `m4g db run`
|
||||
|
||||
If the database, i.e. the mariadb container, doesn't successfully start after running `m4g db run` the first time, then try running it again. This often works, but yeah...it's hacky. However, at the time of writing it's unknown what causes this.
|
||||
|
||||
Reference in New Issue
Block a user