https://github.com/morgankryze/mangodb
Database project with C# UI
https://github.com/morgankryze/mangodb
csharp database db postgresql ui
Last synced: 7 months ago
JSON representation
Database project with C# UI
- Host: GitHub
- URL: https://github.com/morgankryze/mangodb
- Owner: MorganKryze
- License: mit
- Created: 2024-02-21T14:51:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T23:41:28.000Z (over 1 year ago)
- Last Synced: 2024-05-29T07:31:37.128Z (over 1 year ago)
- Topics: csharp, database, db, postgresql, ui
- Language: C#
- Homepage:
- Size: 1.29 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MangoDB
> A database project about a smoothie with a C# console application UI.
## Project structure
The project is divided into the following sections:
- `Diagrams`: Contains the UML and ERD diagrams for the database structure.
- `src/database`: Contains the SQL scripts to create the database and the docker-compose file.
- `src/MangoDB`: Contains the C# console application project.
## Getting started
### Clone the repository
To work with the project, you need to clone the repository on your machine.
```bash
git clone https://github.com/MorganKryze/MangoDB.git
```
or download the zip file.
### Build the diagrams
For the diagrams, we use [PlantUML](https://plantuml.com/). You can use the [PlantUML extension](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) for Visual Studio Code to visualize the diagrams, or you can use the [PlantUML online editor](https://plantuml.com/).
Then you can export the diagrams to images (png for distribution and svg for comfort).
The other one is a draw.io file, you can open it with [draw.io](https://app.diagrams.net/) exported to pdf.
### Build the database
To build the database, you need to have [Docker](https://www.docker.com/) installed on your machine.
Start by duplicating the `src/database/.env.example` file and renaming it to `.env`.
Then, put yourself in the `src/database` directory.
```bash
cd src/database
```
Finally, you can run the following command to build the database.
```bash
docker-compose up
```
### Build the C# console application
To build the C# console application, you need to have [.NET 8](https://dotnet.microsoft.com/download) installed on your machine.
Put yourself in the `src/MangoDB` directory.
```bash
cd src/MangoDB
```
Then, you can run the following command to build the project.
```bash
dotnet run
```
## Credentials
### MangoManager
Username: `manager@mango.fr`
```plaintext
secret
```
### Customers
Username: `john.doe@example.com`
```plaintext
john
```
The other default customers have the same password as John Doe.
## Credits
The project picture was generated by AI on the 21/02/2024, 14:50:27.
## License
The project is licensed under the [MIT license](LICENSE).