Skip to content

Commit 9a9504e

Browse files
dileepadevCopilot
andauthored
feat(main): Release fully documented and deployed API v1.0.0 [#2] (#3)
* feat: Add Swagger UI for API documentation (refs #2) * feat: Add database integration and About endpoint (refs #2) * feat: Add Experience endpoint (refs #2) * feat: Add Education endpoint (refs #2) * feat: Add Events endpoint (refs #2) * feat: Add Videos endpoint (refs #2) * feat: Add Blogs endpoint (refs #2) * feat: Add Community endpoint (refs #2) * feat: Add Tools endpoint (refs #2) * docs: Update README.md and CHANGELOG.md (refs #2) * fix: Add missing fields and attributes to DTO files (refs #2) * feat: Add format field to the event schema and DTO (refs #2) * docs: Update PULL_REQUEST_TEMPLATE.md (refs #2) * fix: Correct typo in education.dto.ts (refs #2) Co-authored-by: Copilot <[email protected]> * fix: Correct typo in about.dto.ts (refs #2) Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 3a0b0cd commit 9a9504e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1643
-45
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
---
1+
# Pull Request
2+
3+
<!--
24
about: Template for Pull Requests
35
title: "<type>(<branch>): <message> [#issue_number]"
46
# Example: "fix(dev): Link cards to a new username [#6]"
5-
---
7+
-->
68

79
## 📜 Description
810

@@ -30,13 +32,16 @@ title: "<type>(<branch>): <message> [#issue_number]"
3032

3133
<!-- [REQUIRED] Tick all that apply -->
3234

33-
- [x] I've followed the [CONTRIBUTING.md](CONTRIBUTING.md).
34-
- [x] I've followed the [Commit Message Guidelines](COMMIT_MESSAGE_GUIDELINES.md).
35-
- [x] I've followed the [Branch Naming Guidelines](BRANCH_NAMING_GUIDELINES.md).
36-
- [x] I agree to follow the [Pull Request Guidelines](PULL_REQUEST_GUIDELINES.md).
37-
- [x] I agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
38-
- [x] Documentation has been updated where necessary.
39-
- [x] I've tested the changes where applicable.
35+
<!-- Use "x" to check. -->
36+
<!-- example: - [x] I've followed the [CONTRIBUTING.md](CONTRIBUTING.md). -->
37+
38+
- [ ] I've followed the [CONTRIBUTING.md](CONTRIBUTING.md).
39+
- [ ] I've followed the [Commit Message Guidelines](COMMIT_MESSAGE_GUIDELINES.md).
40+
- [ ] I've followed the [Branch Naming Guidelines](BRANCH_NAMING_GUIDELINES.md).
41+
- [ ] I agree to follow the [Pull Request Guidelines](PULL_REQUEST_GUIDELINES.md).
42+
- [ ] I agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
43+
- [ ] Documentation has been updated where necessary.
44+
- [ ] I've tested the changes where applicable.
4045

4146
<!-- example:
4247
- [ ] I've tested the changes where applicable:
@@ -45,7 +50,6 @@ title: "<type>(<branch>): <message> [#issue_number]"
4550
- [ ] Devices (iPhone/Android/Laptop/etc.)
4651
- [ ] Operating Systems (Windows/macOS/Linux)
4752
- [ ] Theme modes (Dark mode / Light mode)
48-
4953
-->
5054

5155
## 💬 Additional Comments

CHANGELOG.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,28 @@ All notable changes to this project are documented in this file.
66

77
- Changes for the next release are available in development branches.
88

9-
## [0.0.1]
9+
## [1.0.0] - 2025-05-04
10+
11+
- **Added (New features):**
12+
13+
- Set up initial project structure using [NestJS](https://nestjs.com/) and [TypeScript](https://www.typescriptlang.org/) running on [Node.js](https://nodejs.org/).
14+
- Built and tested the following RESTful API endpoints:
15+
- `/about` – Provides general profile information about me.
16+
- `/experiences` – Returns a list of my professional work experiences and roles.
17+
- `/educations` – Displays my academic background including degrees and institutions.
18+
- `/events` – Lists upcoming or past events, talks, or appearances I’ve been part of.
19+
- `/videos` – Links to video content such as talks, tutorials, or interviews I’ve done.
20+
- `/blogs` – Returns metadata or summaries of blog posts I’ve written.
21+
- `/communities` – Tech communities I've volunteered with, both currently and in the past.
22+
- `/tools` – Lists the tools, frameworks, and technologies I currently work with.
23+
- Configured database using [MongoDB](https://www.mongodb.com/) with [Mongoose](https://mongoosejs.com/) ODM. Seeded initial data and connected it to API endpoints.
24+
- Implemented image upload and delivery via [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/).
25+
- Generated interactive API documentation using [Swagger](https://swagger.io/) and [Swagger UI](https://swagger.io/tools/swagger-ui/).
26+
- Deployed application to production using [Azure App Service](https://azure.microsoft.com/en-us/services/app-service/) with optional CI/CD.
27+
- Integrated code linting and formatting with [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/).
28+
- Managed dependencies using [npm](https://www.npmjs.com/).
29+
30+
## [0.0.1] - 2025-05-04
1031

1132
- **Added (New features):**
1233

@@ -35,7 +56,9 @@ All notable changes to this project are documented in this file.
3556
- Update README.md
3657

3758
<!-- Unreleased -->
59+
<!-- 1.0.0 -->
3860
<!-- v0.0.1 -->
3961

4062
[Unreleased]: https://github.com/dileepadev/api.dileepa.dev/branches
63+
[1.0.0]: https://github.com/dileepadev/api.dileepa.dev/compare/v0.0.1...v1.0.0
4164
[0.0.1]: https://github.com/dileepadev/api.dileepa.dev/releases/tag/v0.0.1

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
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.
44

5+
## Tech Stack
6+
7+
* **Framework:** [NestJS](https://nestjs.com/)
8+
* **Language:** [TypeScript](https://www.typescriptlang.org/)
9+
* **Runtime:** [Node.js](https://nodejs.org/)
10+
* **Package Manager:** [npm](https://www.npmjs.com/)
11+
* **Linting:** [ESLint](https://eslint.org/)
12+
* **Formatting:** [Prettier](https://prettier.io/)
13+
* **Database:** [MongoDB](https://www.mongodb.com/) (using [Mongoose](https://mongoosejs.com/))
14+
* **Deployment:** [Azure App Service](https://azure.microsoft.com/en-us/services/app-service/)
15+
* **Image Hosting:** [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)
16+
* **Documentation:** [Swagger](https://swagger.io/) (using [Swagger UI](https://swagger.io/tools/swagger-ui/))
17+
518
## Installation
619

720
1. Clone the repository:

0 commit comments

Comments
 (0)