Services

---

The Services project contains various services.

Build Status

Build	Tests	GitHub Pages

Folder Structure/Conventions

---

/
├── <module>                    # The module service
├── Automotive                  # The Automotive services
├── Business                    # The Business services
├── cheat-sheets                # The cheat-sheets project
├── Commerce                    # The Commerce services
├── Commodity                   # The Commodity services
├── Education                   # The Education services
├── Healthcare                  # The Healthcare services
├── Logistics                   # The Logistics services
├── Monitoring                  # The Monitoring services
├── Multimedia                  # The Multimedia services
├── Production                  # The Production services
├── Samples                     # The Samples services
├── Security                    # The Security services
├── Technology                  # The Technology services
│    ├── modules                # The modules
│    ├── <service>              # The Service
│    │    ├── <service>-iws     # The <service>-iws Service
│    │    ├── webapp            # The WebApp for Service
│    │    ├── README.md
│    │    └── /
│    ├── README.md
│    └── /
├── README.md                   # Instructions and helpful links
├── robots.txt                  # tells which URLs the search engine crawlers can access on your site
├── <module>                    # The module service
└── /

Project Setup

• Configuration
• Dependencies
• Database Configuration
• Build Instructions
• Unit Tests
• Deployment Instructions

Python Settings

Setup Virtual Environment

Upgrade PIP Requirements (Dependencies)

Setup Configurations

• Create or update local .env configuration file.

By default, Flask will run the application on port 5000.

Build Instructions

Save Requirements (Dependencies)

Unit Tests

Java Conventions

Package Name Conventions

Java package naming conventions are important for organizing code and avoiding naming conflicts. Here's a breakdown of the key rules:

• Lowercase:

  All package names should be in lowercase letters to avoid conflicts with class or interface names.

• Reverse Domain Name:

  Use your reversed internet domain name as the prefix for your package names. For example, if your domain is example.com, your package names would start with com.example.

• Meaningful Names:

  Use meaningful names that describe the purpose of the package and its contents.

• Subpackages:

  Organize code further using subpackages separated by dots (.). For instance, com.example.utilities or com.example.myapp.models.

• Avoid Underscores:

  Avoid using underscores (_) in package names.

Benefits of Packages

• Organization:

  Packages help organize code into logical units, making it easier to navigate and maintain.

• Avoid Conflicts:

  Using reverse domain names helps prevent naming collisions with other projects.

• Clarity:

  Meaningful package names improve code readability and understanding.

REST Generic Endpoints

One generic endpoint:

Method	API
POST	/api/:model
GET	/api/:model/:query
PUT	/api/:model/:id
DELETE	/api/:model/:id

Cloud Environments

Cloud Provider	Region	Region Name
AWS	us-east-1	US East (N. Virginia)
	us-east-2	US East (Ohio)
	us-west-1	US West (N. California)
	us-west-2	US West (Oregon)
	ca-central-1	Canada (Central)
	eu-central-1	Europe (Frankfurt)
	eu-west-1	Europe (Ireland)
	eu-west-2	Europe (London)
	ap-northeast-1	Asia Pacific (Tokyo)
	ap-southeast-1	Asia Pacific (Singapore)
	ap-southeast-2	Asia Pacific (Sydney)
Azure	Region	Name
Provider	Region	Name
Provider	Region	Name
Provider	Region	Name
Provider	Region	Name

Docker Version

docker --version

AWS Version

aws --version

Remove All Comments after a commit

• Get a commit you want to move to i.e. aea90b5

git reset --hard aea90b5
git push -f

Reference

---

• MVN Repository
• Automotive
• Business
• Commerce
• Commodity
• Education
• Healthcare
• Infrastructure
• Docker
• Apache HTTP Server
• Jenkins
• Logistics
• Monitoring
• Multimedia
• Samples
• Technology
• The Java™ Tutorials - Naming a Package
• Python
• Web Links

Author

---

• Rohtash Lakra

Build Version Structure

{
    "MAJOR": "MAJOR",
    "MINOR": "MINOR",
    "PATCH": "PATCH",
    "PRE-RELEASE": "PRE-RELEASE",
    "BUILD": "BUILD"
}

OR

MAJOR.MINOR.PATCH.PRE-RELEASE.BUILD

Contribution Guidelines

• Writing tests
• Code review
• Other Guidelines