Piperchat

Piperchat
Explore the docs »

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• Node.js

  • TypeScript
  • Express
  • Socket.io
  • Mongoose
  • Amqplib
  • Vue.js

• MongoDB

• RabbitMQ

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Node.js
• Docker

Installation

1. Clone the Repository:

   $ git clone https://github.com/zucchero-sintattico/piperchat.git

2. Install Dependencies:

   $ npm i

3. Copy Environment Variables:

   $ cp .env.template .env

4. Deploy the Architecture (including Image Build):

   $ ./cleanDeploy.sh

5. Subsequent Deployments (Preserving Volumes and Images):

   $ ./deploy.sh

Contributing

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

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

License

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

Contact

Project Link: https://github.com/zucchero-sintattico/piperchat

Acknowledgements

• Alessandro Mazzoli
• Manuel Andruccioli
• Luigi Borriello
• Tommaso Patriti