MASTER-README

The title must be replaced by the application's name>.

Description

This project is designed to .... and the main features are ...

Getting Started

Prerequisites

List all dependencies and their version needed by the project as :

• DataBase Engine (MySql, PostgreSQL, MSSQL,...)
• IDE used (PhpStorm, Visual Studio Code, IntelliJ,...)
• Package manager (Nuget, Composer, npm, ...)
• OS supported (W2k22, Debian12,...)
• Virtualization (Docker, .Net, .JDK, .JRE)

Configuration

How to set up the database? How do you set the sensitive data?

Deployment

On dev environment

How to get dependencies and build? How to run the tests?

On integration environment

How to deploy the application outside the dev environment.

Directory structure

• Tip: try the tree bash command

├───Docs
├───Shopping                                        //classes and packages
│   ├───bin                                         //the binary to deploy on the end-user environment
│   │   └───Debug
│   └───obj
│       └───Debug                                   
└───TestShopping                                    //test classes
    ├───bin
    │   └───Debug
    └───obj
        └───Debug

Collaborate

• Take time to read some readme and find the way you would like to help other developers collaborate with you.

• They need to know:

  • How to propose a new feature (issue, pull request)
  • How to commit
  • How to use your workflow

License

• Choose the license adapted to your project.

Contact

• How to get in contact with you? Discord, Trello, Issue?