545563e776
- Complete NestJS TypeScript implementation with WebSocket support - Direct messaging (DM) and group chat functionality - End-to-end encryption with AES encryption and key pairs - Media file support (images, videos, audio, documents) up to 100MB - Push notifications with Firebase Cloud Messaging integration - Mention alerts and real-time typing indicators - User authentication with JWT and Passport - SQLite database with TypeORM entities and relationships - Comprehensive API documentation with Swagger/OpenAPI - File upload handling with secure access control - Online/offline status tracking and presence management - Message editing, deletion, and reply functionality - Notification management with automatic cleanup - Health check endpoint for monitoring - CORS configuration for cross-origin requests - Environment-based configuration management - Structured for Flutter SDK integration Features implemented: ✅ Real-time messaging with Socket.IO ✅ User registration and authentication ✅ Direct messages and group chats ✅ Media file uploads and management ✅ End-to-end encryption ✅ Push notifications ✅ Mention alerts ✅ Typing indicators ✅ Message read receipts ✅ Online status tracking ✅ File access control ✅ Comprehensive API documentation Ready for Flutter SDK development and production deployment.
42 lines
995 B
Markdown
42 lines
995 B
Markdown
# Contributing
|
|
|
|
Thanks for contributing!
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
git clone https://github.com/prettier/prettier-linter-helpers.git
|
|
cd prettier-linter-helpers
|
|
yarn install
|
|
```
|
|
|
|
## Running the tests
|
|
|
|
```sh
|
|
yarn run test
|
|
```
|
|
|
|
Linting is ran as part of `yarn run test`. The build will fail if there are any linting errors. You can run `yarn run lint --fix` to fix some linting errors (including formatting to match prettier's expectations). To run the tests without linting run `yarn run test`.
|
|
|
|
## Publishing
|
|
|
|
- Ensure you are on the master branch locally.
|
|
- Update `CHANGELOG.md` and commit.
|
|
- Run the following:
|
|
|
|
```sh
|
|
yarn publish
|
|
git push --follow-tags
|
|
```
|
|
|
|
Running `yarn publish` shall:
|
|
|
|
- Bump the version in package.json (asking you for the new version number)
|
|
- Create a new commit containing that version bump in package.json
|
|
- Create a tag for that commit
|
|
- Publish to the npm repository
|
|
|
|
Running `git push --follow-tags` shall:
|
|
|
|
- Push the commit and tag to GitHub
|