Setup Check

This repository is used for educational purposes.

Description

It lets you get :

• To grips with the language,
• Validate the proper functioning of its development environment,
• Train basic git commands.

Getting Started

Prerequisites

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

Note : only tested on Windows 11

Role	Name	Version
IDE	PyCharm	2024.2.4
Interpreter	Python	3.31.0
Package Manager	Pip	24.3.1
VCS	Git	24.3.1

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

├───src                                             //source code
├───test                                            //test file
├───.gitignore                                      //main .gitignore
└───README                                          //repo readme

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?