MedAzizKhayati / maawf_backend

MAAWF.me

An awesome light weight e2e encrypted messaging app
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Deploying
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

This is our lightweight message web app. offers the typical chatting app features like group chat and networking features

(back to top)

Built With

This project is built mainly using NestJs, Mysql, Typeorm

• [![NestJs][nest.js]][nestjs-url]

(back to top)

Getting Started

Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

First make sure you have npm and node installed

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install NPM packages

• npm

  npm install

• yarn

  yarn

(back to top)

Usage

Start development server

• npm

  npm run start:dev

• yarn

  yarn run start:dev

(back to top)

Deploying

To automatically run the deployment from dev all the way to production, you can use the following command:

• bash

   git checkout dev && git pull && git push && git checkout test && git merge dev && git push && git checkout prod && git merge test && git push && git checkout dev

Roadmap

• Add Authentication Module
• Add Secure Messaging Module
• Add Friendship and Friends Module
• Add Group chats
• Add User Profile (in works)
• Add User Feed (homepage)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Img Shields
• GitHub Pages

(back to top)