https://github.com/orgball2608/classroom-be
https://github.com/orgball2608/classroom-be
aws-s3 bullmq docker docker-compose event-emitter exceljs github-actions grafana nestjs nodemailer postgresql prisma prometheus redis swc websocket
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/orgball2608/classroom-be
- Owner: orgball2608
- Created: 2023-11-08T13:42:27.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-10T07:16:07.000Z (5 months ago)
- Last Synced: 2025-06-09T21:08:32.401Z (4 months ago)
- Topics: aws-s3, bullmq, docker, docker-compose, event-emitter, exceljs, github-actions, grafana, nestjs, nodemailer, postgresql, prisma, prometheus, redis, swc, websocket
- Language: TypeScript
- Homepage: https://be-webnc.onrender.com/api-docs
- Size: 1.12 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Final project of the Advanced Web Application Development subject - 2023
# GETTING STARTED
```bash
# 1. Clone the repository
git clone https://github.com/orgball2608/classroom-be.git
# 2. Enter your newly-cloned folder.
cd classroom-be
# 3. Create Environment variables file.
cp .env.example .env
#4 Run prisma migrate reset
yarn prisma migrate reset
# 3. Install dependencies. (Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install)
yarn
```
# DEVELOPMENT
## Run development server and open http://localhost:3001
```
yarn run start:dev
```
or
```
docker-compose -f docker-compose.local.yaml up
```
# GIT RULES
## Git Flow Workflow
The Git Flow workflow consists of the following main branches and their purposes:
- `master`: Represents the stable production-ready code. Only merge releases into this branch.
- `develop`: Serves as the integration branch for ongoing development. Feature branches are merged into this branch.
- `feature`: Used to develop new features. Each feature should have its own branch branched off from `develop`.
- `release`: Created for preparing a new release. Bug fixes and last-minute changes can be made in this branch.
- `hotfix`: Created to quickly address critical issues in the production code. Branched off from `master`.
## Branches in Git Flow
In Git Flow, branches have specific naming conventions to indicate their purpose:
- Feature branch: `feature/`
- Release branch: `release/`
- Hotfix branch: `hotfix/`
## Using Rebase in Git Flow
To incorporate rebase into the Git Flow workflow, follow these steps:
1. Start a new feature: Create a new feature branch from `develop`.
2. Work on the feature: Make commits to the feature branch as you develop the new feature.
3. Update the feature branch: Before completing the feature, rebase it onto the latest `develop` branch to incorporate the latest changes.
4. Resolve conflicts: If conflicts occur during the rebase process, resolve them by editing the conflicting files manually.
5. Complete the feature: Once the feature is complete and conflicts are resolved, merge the feature branch into `develop`.
6. Repeat the process: Continue working on new features or start a release/hotfix branch following the same principles.