Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/techcell-project/tech-cell-server
Back-end application for TechCell
https://github.com/techcell-project/tech-cell-server
docker i18n letsencrypt microservice mongodb nest nestjs nginx nodejs rabbitmq redis swagger typescript
Last synced: 3 days ago
JSON representation
Back-end application for TechCell
- Host: GitHub
- URL: https://github.com/techcell-project/tech-cell-server
- Owner: TechCell-Project
- License: mit
- Created: 2023-06-06T03:17:59.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2024-03-20T12:57:16.000Z (11 months ago)
- Last Synced: 2024-03-20T21:42:15.358Z (11 months ago)
- Topics: docker, i18n, letsencrypt, microservice, mongodb, nest, nestjs, nginx, nodejs, rabbitmq, redis, swagger, typescript
- Language: TypeScript
- Homepage: https://api.techcell.cloud
- Size: 23.9 MB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A progressive Node.js framework for building efficient and scalable server-side applications.
# 🚀 Deployed
- RESTful API: [api.techcell.cloud](https://api.techcell.cloud)
- Documentations: [docs.techcell.cloud](https://docs.techcell.cloud)
- Source code docs: [architecture.techcell.cloud](https://architecture.techcell.cloud)
# 📖 Description
This application is built using a microservices architecture with [Nest](https://nestjs.com/) and [RabbitMQ](https://www.rabbitmq.com/). It includes the following features:
- **Infrastructure:**
- Monorepo with [Nest Monorepo](https://docs.nestjs.com/cli/monorepo#monorepo-mode)
- Containerization with [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/)
- Message Broker with [RabbitMQ](https://www.rabbitmq.com/)
- Cache with [Redis](https://redis.io/)
- Database with [MongoDB](https://www.mongodb.com/)
- Job queue with [BullMQ](https://bullmq.io/)
- Deploy with [Google Cloud](https://cloud.google.com/), [Azure](https://azure.microsoft.com/), and other cloud services
- CI/CD with [Github Actions](https://github.com/features/actions)
- Reverse proxy with [Nginx](https://www.nginx.com/)
- SSL with [Let's Encrypt](https://letsencrypt.org/), [ZeroSSL](https://zerossl.com/), and [Cloudflare](https://www.cloudflare.com/)
- High availability with [HAProxy](https://www.haproxy.org/)
- **Features:**
- User, Profile, Product, Order, Category, Notification, Attribute, Cart, Otp management ...
- Transaction order with [Mongodb transaction](https://docs.mongodb.com/manual/core/transactions/) and distributed lock with [Redlock](https://redis.io/topics/distlock)
- Multi languages with [i18n](https://www.npmjs.com/package/i18n)
- Authentication with [JWT](https://jwt.io/)
- Login, sign up with Credentials (email verified), Google
- Storage with [Cloudinary](https://cloudinary.com/)
- Custom domain emails with [Sendgrid](https://sendgrid.com/), [Resend](https://resend.com/), and [Gmail](https://mail.google.com/)
- Notifications with [Socket.io](https://socket.io/), using job queue to send notifications
- Cron jobs to clean unused data
- Payment integration with [VNPay](https://vnpay.vn/)
- Shipping integration with [GiaoHangNhanh](https://ghn.vn/)
# 📦 Installation
## ⚡ Require installed
- Docker, docker-compose ...
- Or custom install:
* Nodejs: [nodejs 18](https://nodejs.org/en/blog/announcements/v18-release-announce)
* Package Manager: [yarn](https://yarnpkg.com/)
* Message Broker: [RabbitMQ](https://www.rabbitmq.com/)
* Database: [Mongodb](https://www.mongodb.com/) with [replica set mode](https://www.mongodb.com/docs/manual/replication/) or [mongodb atlas](https://www.mongodb.com/docs/atlas/)
* Cache: [Redis](https://redis.io/)
## ⚠️ Attention:
- [Ubuntu](https://ubuntu.com/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) (Windows subsystems for Linux) is **recommended** for both development and production
- Windows is **not** recommended, can use in development **not** for production
## 📝 Before start
- Copy the .env.example and rename to .env.
- Change the default values to your own.
## 🐳 With docker, docker-compose
### 🔨 Services
- Core services:
* Database
* Message Broker
* Reverse proxy
- Application services (each folder in `apps` folder is a service):
* api
* auth
* search
* .etc..
### Starting
#### First, you need to start the core services
```bash
yarn up:core # start core services
```
#### Then, you can start the application services
- `service_name` - optional: is the name of the service you want to start, by default it will start all services
```bash
yarn up:prod # start all services in production mode
```
### Stopping
- `service_name` - optional: is the name of the service you want to start, by default it will start all services
```bash
yarn down:prod # stop all services
# or
yarn down:core # stop core services
```
### Restart and rebuild
- `service_name` - optional: is the name of the service you want to start, by default it will start all services
```bash
yarn restart:prod # restart and rebuild all services
# or
yarn restart:core # restart and rebuild core services
```
### Update the services
- `service_name` - optional: is the name of the service you want to start, by default it will start all services
- Update the services to the latest version from the docker registry
- Make sure your github repository is up to date
```bash
git pull # update the repository
yarn update:prod # update core services
```
## 🦽 With manual run
### Required
- Make sure all the following core services have been installed and run successfully
* RabbitMQ: port 5672
* Mongodb: port 27017, replica set mode
* Redis: port 6379
- Or you can run core services in docker and run app services manually
- Or you can using cloud services like [mongodb atlas](https://www.mongodb.com/cloud/atlas), [redis cloud](https://redislabs.com/redis-enterprise-cloud/overview/), [rabbitmq cloud](https://www.cloudamqp.com/)
### Starting
- `service_name` - optional: is the name of the service you want to start, by default it is `api` service
```bash
# You can run core services in docker and run app services manually
yarn start # start the service as normal mode
yarn start:dev # start the service as development mode
yarn start:prod # start the service as production mode
```
### Stopping
```bash
# Just CTRL-C to stop the service
```
### Use Docker
- Check what is running on docker:
```bash
docker ps -a
```
- Get the log of a container:
```bash
docker logs # get logs
docker logs -f # get logs realtime
# Remember to replace `` with the actual ID of the container you want to inspect.
```
- To remove all containers, volumes, and images that are not currently running, you can use the following commands:
```bash
docker container prune # remove all stopped containers
docker volume prune # remove all unused volumes
docker image prune # remove all unused images
# or just one
docker system prune -a # remove all stopped containers and unused volumes, images
```
## 🦽 License
Nest is [MIT licensed](LICENSE).