feat(main): Enhance /about endpoint & refactor API structure for v1.1.0 [#4] (#5)

* feat: Update About DTO and schema (refs #4)

* feat: Update the description field in 'About' to support an array (refs #4)

* feat: Update the services to sort by the sortDate field (refs #4)

* feat: Remove views field from Videos (refs #4)

* feat: Remove readTime field from Blogs and add link field (refs #4)

* feat: Update About DTO and schema (refs #4)

* feat: Update MongoDB uri and add .env.exampl (refs #4)

* chore: Update version to 1.1.0 (refs #4)

* docs: Add VERSIONING.md, update CHANGELOG.md & README.md (refs #4)

* fix: About DTO ISEmail (refs #4)

Author: dileepadev-old

.env.example

@@ -0,0 +1,21 @@
+# Example .env file for api.dileepa.dev
+# Copy this file to .env and fill in the values as needed
+
+# Application
+PORT=3000
+NODE_ENV=development
+
+# MongoDB
+MONGODB_URI=mongodb://localhost:27017/dileepa
+
+# Azure Blob Storage
+AZURE_STORAGE_ACCOUNT_NAME=your_storage_account_name
+AZURE_STORAGE_ACCOUNT_KEY=your_storage_account_key
+AZURE_STORAGE_CONTAINER_NAME=your_container_name
+
+# Other secrets (add as needed)
+JWT_SECRET=your_jwt_secret
+
+# Swagger (optional)
+SWAGGER_USER=admin
+SWAGGER_PASSWORD=your_password

CHANGELOG.md

@@ -2,13 +2,33 @@
 
 All notable changes to this project are documented in this file.
 
+Changes are organized into the following categories:
+
+- **Added:** New features or functionality introduced to the project.
+- **Changed:** Modifications to existing functionality that do not add new features.
+- **Fixed:** Bug fixes that resolve issues or correct unintended behavior.
+- **Removed:** Features or components that have been removed from the project.
+
 ## [Unreleased]
 
 - Changes for the next release are available in development branches.
 
+## [1.1.0] - 2025-05-12
+
+- **Added:**
+
+  - Add social media and other relevant external links to the `/about` endpoint for better representation.
+  - Add `VERSIONING.md` file to document the versioning strategy and release process for the project.
+
+- **Changed:**
+
+  - Update the `description` field in the `/about` endpoint to support an array of multiple descriptive entries, allowing for more detailed and modular content.
+  - Refactor the DTO (Data Transfer Object) structure to follow `camelCase` naming conventions for consistency with frontend standards.
+  - Update MongoDB queries to return data ordered by date for improved relevance.
+
 ## [1.0.0] - 2025-05-04
 
-- **Added (New features):**
+- **Added**
 
   - Set up initial project structure using [NestJS](https://nestjs.com/) and [TypeScript](https://www.typescriptlang.org/) running on [Node.js](https://nodejs.org/).
   - Built and tested the following RESTful API endpoints:
@@ -29,7 +49,7 @@ All notable changes to this project are documented in this file.
 
 ## [0.0.1] - 2025-05-04
 
-- **Added (New features):**
+- **Added:**
 
   - Initialize project with **NestJS**
   - Add Documentation:
@@ -51,14 +71,16 @@ All notable changes to this project are documented in this file.
       - [`other.md`](https://github.com/dileepadev/api.dileepa.dev/blob/main/.github/ISSUE_TEMPLATE/other.md)
   - Deploy the app to the production environment.
 
-- **Changed (Improvements):**
+- **Changed:**
 
   - Update README.md
 
 <!-- Unreleased -->
+<!-- 1.1.0 -->
 <!-- 1.0.0 -->
 <!-- v0.0.1 -->
 
 [Unreleased]: https://github.com/dileepadev/api.dileepa.dev/branches
+[1.1.0]: https://github.com/dileepadev/api.dileepa.dev/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/dileepadev/api.dileepa.dev/compare/v0.0.1...v1.0.0
 [0.0.1]: https://github.com/dileepadev/api.dileepa.dev/releases/tag/v0.0.1

README.md

@@ -2,25 +2,46 @@
 
 This is the API for Dileepa's personal website ([dileepa.dev](https://dileepa.dev)), built with [NestJS](https://nestjs.com/). It provides various endpoints to access information about Dileepa and other related data.
 
-## Tech Stack
-
-* **Framework:** [NestJS](https://nestjs.com/)
-* **Language:** [TypeScript](https://www.typescriptlang.org/)
-* **Runtime:** [Node.js](https://nodejs.org/)
-* **Package Manager:** [npm](https://www.npmjs.com/)
-* **Linting:** [ESLint](https://eslint.org/)
-* **Formatting:** [Prettier](https://prettier.io/)
-* **Database:** [MongoDB](https://www.mongodb.com/) (using [Mongoose](https://mongoosejs.com/))
-* **Deployment:** [Azure App Service](https://azure.microsoft.com/en-us/services/app-service/)
-* **Image Hosting:** [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)
-* **Documentation:** [Swagger](https://swagger.io/) (using [Swagger UI](https://swagger.io/tools/swagger-ui/))
+## Table of Contents
+
+- [api.dileepa.dev](#apidileepadev)
+  - [Table of Contents](#table-of-contents)
+  - [Tools and Technologies](#tools-and-technologies)
+  - [Installation](#installation)
+  - [Running the App](#running-the-app)
+    - [Development](#development)
+    - [Production](#production)
+  - [API Documentation](#api-documentation)
+  - [Testing](#testing)
+  - [Versioning](#versioning)
+  - [Contributing](#contributing)
+  - [Issues](#issues)
+  - [Security](#security)
+  - [License](#license)
+  - [API Endpoints](#api-endpoints)
+  - [Deployment on Azure](#deployment-on-azure)
+  - [Contact](#contact)
+
+## Tools and Technologies
+
+- **Framework:** [NestJS](https://nestjs.com/)
+- **Language:** [TypeScript](https://www.typescriptlang.org/)
+- **Runtime:** [Node.js](https://nodejs.org/)
+- **Package Manager:** [npm](https://www.npmjs.com/)
+- **Linting:** [ESLint](https://eslint.org/)
+- **Formatting:** [Prettier](https://prettier.io/)
+- **Version Control:** [Git](https://git-scm.com/)
+- **Database:** [MongoDB](https://www.mongodb.com/) (using [Mongoose](https://mongoosejs.com/))
+- **Deployment:** [Azure App Service](https://azure.microsoft.com/en-us/services/app-service/)
+- **Image Hosting:** [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)
+- **Documentation:** [Swagger](https://swagger.io/) (using [Swagger UI](https://swagger.io/tools/swagger-ui/))
 
 ## Installation
 
 1. Clone the repository:
 
    ```bash
-   git clone https://github.com/your-username/api.dileepa.dev.git 
+   git clone https://github.com/dileepadev/api.dileepa.dev.git
    cd api.dileepa.dev
    ```
 
@@ -30,6 +51,13 @@ This is the API for Dileepa's personal website ([dileepa.dev](https://dileepa.de
    npm install
    ```
 
+3. Copy the example environment file and update it with your configuration:
+
+   ```bash
+   cp .env.example .env
+   # Then edit .env as needed
+   ```
+
 ## Running the App
 
 ### Development
@@ -40,7 +68,7 @@ To run the application in development mode with file watching:
 npm run start:dev
 ```
 
-The application will be available at `http://localhost:3000` (or the configured port).
+The application will be available at `http://localhost:3000` (or the configured port in `.env`).
 
 ### Production
 
@@ -51,23 +79,35 @@ npm run build
 npm run start:prod
 ```
 
-## Linting and Formatting
+## API Documentation
 
-To lint the codebase:
+Swagger UI is available at [`/api`](http://localhost:3000/api) once the app is running. (e.g., `http://localhost:3000/api`)
 
-```bash
-npm run lint
-```
+## Testing
 
-To format the codebase using Prettier:
+To run tests:
 
 ```bash
-npm run format
+npm run test
 ```
 
+## Versioning
+
+This project follows a versioning pattern similar to [Semantic Versioning](https://semver.org/) (SemVer) for managing releases. For detailed versioning information, see the [VERSIONING.md](VERSIONING.md) file.
+
 ## Contributing
 
-Contributions are welcome! Please follow the guidelines outlined in [CONTRIBUTING.md](CONTRIBUTING.md) and adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). Also, review the [Branch Naming](BRANCH_NAMING_GUIDELINES.md), [Commit Message](COMMIT_MESSAGE_GUIDELINES.md), and [Pull Request](PULL_REQUEST_GUIDELINES.md) guidelines.
+Contributions are welcome! Please read the following before contributing:
+
+- [CONTRIBUTING.md](CONTRIBUTING.md)
+- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
+- [BRANCH_NAMING_GUIDELINES.md](BRANCH_NAMING_GUIDELINES.md)
+- [COMMIT_MESSAGE_GUIDELINES.md](COMMIT_MESSAGE_GUIDELINES.md)
+- [PULL_REQUEST_GUIDELINES.md](PULL_REQUEST_GUIDELINES.md)
+
+## Issues
+
+For any issues or feature requests, please use the [issue templates](.github/ISSUE_TEMPLATE) provided in the repository. You can also check the [CHANGELOG.md](CHANGELOG.md) for updates and changes.
 
 ## Security
 
@@ -76,3 +116,24 @@ If you discover any security vulnerabilities, please report them as described in
 ## License
 
 This project is licensed under the terms of the [LICENSE](LICENSE) file.
+
+## API Endpoints
+
+| Endpoint      | Description                                           |
+|---------------|-------------------------------------------------------|
+| `/about`      | Provides general profile information about me.        |
+| `/experiences`| Returns a list of my professional work experiences.   |
+| `/educations` | Displays my academic background, including degrees.   |
+| `/events`     | Lists upcoming and past events, talks, or appearances.|
+| `/videos`     | Links to video content such as talks or tutorials.    |
+| `/blogs`      | Returns metadata or summaries of blog posts.          |
+| `/communities`| Tech communities I've volunteered with.               |
+| `/tools`      | Lists the tools, frameworks, and technologies I use.  |
+
+## Deployment on Azure
+
+This project is designed for deployment on Azure App Service and uses Azure Blob Storage for image hosting. For deployment instructions, see the [official Azure documentation](https://docs.microsoft.com/en-us/azure/app-service/quickstart-nodejs?tabs=windows).
+
+## Contact
+
+For any inquiries or feedback, please reach out to me via [email](mailto:contact@dileepa.dev) or through my [website](https://dileepa.dev).

VERSIONING.md

@@ -0,0 +1,78 @@
+# Versioning
+
+This project follows a versioning pattern similar to [Semantic Versioning](https://semver.org/) (SemVer) for managing releases.
+
+## Table of Contents
+
+- [Versioning](#versioning)
+  - [Table of Contents](#table-of-contents)
+  - [Format](#format)
+    - [Examples](#examples)
+  - [Release Process](#release-process)
+    - [Typical Steps](#typical-steps)
+  - [Pre-release Versions](#pre-release-versions)
+  - [Viewing Tags \& Differences](#viewing-tags--differences)
+  - [Questions or Issues?](#questions-or-issues)
+
+## Format
+
+Version numbers follow the structure:
+
+`MAJOR.MINOR.PATCH`
+
+- **MAJOR** – Incompatible API changes or major breaking updates  
+- **MINOR** – Backward-compatible functionality and feature additions  
+- **PATCH** – Backward-compatible bug fixes and small improvements
+
+### Examples
+
+- `1.0.0` – First stable release  
+- `1.1.0` – Adds a new endpoint or feature  
+- `1.1.1` – Fixes a bug or makes a minor improvement
+
+## Release Process
+
+All notable changes are documented in the [CHANGELOG.md](CHANGELOG.md) file.
+
+### Typical Steps
+
+1. Complete all features and fixes planned for the release
+2. Update the `CHANGELOG.md` with categorized entries:  
+   - **Added**, **Changed**, **Fixed**, **Removed**
+3. Bump the version number in `package.json` (and `package-lock.json` if needed)
+4. Commit changes with a version-related message (e.g. `chore: release v1.2.0`)
+5. Tag the release:
+
+   ```bash
+   git tag v1.2.0
+   git push origin v1.2.0
+   ```
+
+6. (Optional) Create a GitHub release and paste the relevant changelog section
+
+## Pre-release Versions
+
+For beta or release candidates, we use suffixes:
+
+- `1.2.0-beta.1` – Beta release  
+- `2.0.0-rc.1` – Release candidate  
+
+These versions are intended for testing and may not be fully stable.
+
+## Viewing Tags & Differences
+
+List all version tags:
+
+```bash
+git tag
+```
+
+View differences between versions:
+
+```bash
+git log v1.1.0..v1.2.0
+```
+
+## Questions or Issues?
+
+If you have questions about the versioning strategy or encounter version-related problems, feel free to open an issue on the [GitHub repository](https://github.com/dileepadev/api.dileepa.dev/issues).

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "api.dileepa.dev",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "This API provides access to Dileepa Bandara's personal and other related data.",
   "author": {
     "name": "Dileepa Bandara",

package.json

@@ -20,7 +20,7 @@ import { ToolsModule } from './tools/tools.module';
     MongooseModule.forRootAsync({
       imports: [ConfigModule],
       useFactory: (configService: ConfigService) => ({
-        uri: configService.get<string>('DATABASE_CONNECTION_STRING'),
+        uri: configService.get<string>('MONGODB_URI'),
       }),
       inject: [ConfigService],
     }),

src/app.module.ts

@@ -12,6 +12,10 @@ export class BlogsService {
   ) {}
 
   async findAll(): Promise<BlogDto[]> {
-    return this.blogModel.find().exec();
+    return this.blogModel
+      .find()
+      .sort({ sortDate: -1 })
+      .select('-sortDate')
+      .exec();
   }
 }

src/blogs/blogs.service.ts

@@ -12,6 +12,10 @@ export class CommunitiesService {
   ) {}
 
   async findAll(): Promise<CommunityDto[]> {
-    return this.communityModel.find().exec();
+    return this.communityModel
+      .find()
+      .sort({ sortDate: -1 })
+      .select('-sortDate')
+      .exec();
   }
 }