Skip to content

Commit 9b41a2f

Browse files
docker api setup and updated readme
1 parent 0f2ff84 commit 9b41a2f

15 files changed

+159
-7362
lines changed

.dockerignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.git
2+
.github
3+
node_modules
4+
**/node_modules
5+
**/dist
6+
**/.env
7+
**/.next
8+
**/build
9+
**/*.log
10+
coverage

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,28 @@ Built with React, NestJS, TypeScript, and modern cloud services, MindsMesh showc
88

99
Each feature of this project represents both a functional solution and a learning milestone in my development journey 🌱.
1010

11-
🧙‍♂️👨‍💻 **At the moment I am implementing the following:**
11+
🧙‍♂️👨‍💻 ***At the moment I am implementing the following:***
1212

1313
👥🔍 **AI feature that helps recommending relevant freelancers to logged in employer users based on their project requirements.**
1414

15+
🚢 ***New DevOps Features***
16+
17+
- 🐳**Docker for API Testing:**
18+
- Start the Docker Desktop if on Windows or Docker Engine on Linux.
19+
- Execute shell script `docker-api-up.sh` in a wsl terminal.
20+
- 🧪 Test the endpoints directly in the browser using Swagger accessing <http://localhost:3000/api-docs>.
21+
22+
- 🔄**GitHub Actions:** CI/CD pipeline.
23+
- CI Pipeline: Automatically runs tests and linting on pull requests and pushes to main branch
24+
-✅ Build Verification: Ensures the application builds successfully in a clean environment.
25+
- Future Implementation: Automated deployment to staging/production environments.
26+
27+
📎***New Chat Attachment feature:***
28+
29+
- **Send and Receive Attachments** : Share files, images, and documents with ease
30+
- **Multiple File Types** 🖼️ 📄 📝- Share images, PDFs, Word documents, and text **(files Maximum file size: 10MB)**
31+
- ***Seamless Experience*** - Files are stored securely in 🔥🔥Firebase Storage 🔥🔥 and accessible across devices
32+
1533
<!-- a booking system, and a review system. Additionally, it includes an admin dashboard for managing users, skills, and bookings, providing a seamless experience for both users and administrators. -->
1634

1735
![MindsMesh logo](/apps/client/src/assets/logo.svg)
@@ -57,11 +75,6 @@ Each feature of this project represents both a functional solution and a learnin
5775
- **Message Status Indicators** ✔️: See when your messages are sending, sent, or if there was an error
5876
- **Connection Status** 🔌: Visual indicators show if you are connected or reconnecting
5977

60-
#### 📎New Chat Attachment feature:
61-
62-
- **Send and Receive Attachments** : Share files, images, and documents with ease
63-
- **Multiple File Types** 🖼️ 📄 📝- Share images, PDFs, Word documents, and text **(files Maximum file size: 10MB)**
64-
- ***Seamless Experience*** - Files are stored securely in 🔥🔥Firebase Storage 🔥🔥 and accessible across devices
6578
<!-- ### 📅 Booking System
6679
6780
- **Book Lessons:** Users can book lessons from available skill offerings.
@@ -115,12 +128,6 @@ Each feature of this project represents both a functional solution and a learnin
115128
**Messaging with Socket.IO** -->
116129
<!-- **Stripe integration for payments** -->
117130

118-
<!-- ### 🚢 DevOps
119-
120-
- **Docker:** Containerization.
121-
- **Heroku/DigitalOcean:** Deployment.
122-
- **GitHub Actions:** CI/CD pipeline. -->
123-
124131
## 🧑‍💻 Development Steps
125132

126133
1. **Project Setup:**

apps/api/.dockerignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

apps/api/Dockerfile

Lines changed: 0 additions & 74 deletions
This file was deleted.

apps/api/docker-compose.dev.yml

Lines changed: 0 additions & 40 deletions
This file was deleted.

apps/api/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"@nestjs/platform-express": "^10.3.10",
3535
"@nestjs/platform-socket.io": "^10.4.6",
3636
"@nestjs/serve-static": "^4.0.2",
37-
"@nestjs/swagger": "^7.4.2",
37+
"@nestjs/swagger": "^10.0.0",
3838
"@nestjs/throttler": "^6.2.1",
3939
"@nestjs/typeorm": "^10.0.2",
4040
"@nestjs/websockets": "^10.4.6",
@@ -43,7 +43,7 @@
4343
"body-parser": "^1.20.3",
4444
"cache-manager": "^5.7.6",
4545
"class-transformer": "^0.5.1",
46-
"class-validator": "^0.14.1",
46+
"class-validator": "^0.14.0",
4747
"cloudinary": "^1.41.3",
4848
"dotenv": "^16.4.5",
4949
"firebase": "^11.5.0",
@@ -58,7 +58,8 @@
5858
"reflect-metadata": "^0.2.0",
5959
"rxjs": "^7.8.1",
6060
"socket.io": "^4.8.1",
61-
"swagger-ui-express": "^5.0.1"
61+
"swagger-ui-express": "^5.0.1",
62+
"typeorm": "^0.3.15"
6263
},
6364
"devDependencies": {
6465
"@nestjs/cli": "^10.4.5",
@@ -87,7 +88,6 @@
8788
"ts-node": "^10.9.2",
8889
"tsconfig-paths": "^4.2.0",
8990
"tslib": "^2.7.0",
90-
"typeorm": "^0.3.20",
9191
"typeorm-ts-node-commonjs": "^0.3.20",
9292
"typescript": "^5.6.3"
9393
},

0 commit comments

Comments
 (0)