Communet

The open source bulk mailing utility for all your needs
Explore the docs »

Liv link View Demo · Report Bug · Request Feature

Communet is a cutting-edge open source platform dedicated to automating and enhancing outreach efforts for businesses, marketers, and individuals alike. With a focus on automation, personalization, and scalability, Communet offers a comprehensive suite of tools to streamline emails and facilitate communication with target audiences empowering users with intuitive solutions that optimize time efficiency and drive meaningful engagement.

Here's why you shoudld consider using communet:

• Your time is precious, and to optimize it, you write and we handle the email sending process for you.
• You can manage your receipients at your convinence .
• Last but not the least you can add personalization to your mail to keep it unique to everyone.

These are some of the utilities frameworks languages and tools that we used to build the platform.

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Clone the repo and navigate to the Mailer_frontend path and install all the dependencies

• Installing dependencies

  npm install 

• Run the app

   npm run dev

• navigate to localhost:5173 to visit the locally set up project

Here are some simple steps, following which you can use th platform at it's full potential

1. you can add profile by manual entry

1. Edit the profile using actions for the profile

2. Delete the profile using actions for the profile

1. Clone the Repository bash [email protected]:Commu-net/Communet-Api.git

2. Install nx globally bash npm i -g nx

3. Build the containers for each Service. bash docker-compose up --build

4. User Endpoints

• URL: /
• Method: GET
• Description: Returns a link to the Google authentication route.

• URL: /auth/google/
• Method: GET
• Description: Initiates the Google authentication process. The scope of the authentication includes the user's profile, email, and the ability to compose Gmail messages. The access type is set to 'offline', and the approval prompt is set to 'force'.

• URL: /auth/google/callback/
• Method: GET
• Description: Callback route for Google to call after authentication. If the authentication is successful, the user is redirected to the Google success route. If the authentication fails, the user is redirected to the Google failure route.

• URL: /auth/google/success
• Method: GET
• Description: Handles successful Google authentication. The user's email, name, sub, and id are returned as query parameters in a redirect to the client URL.

• URL: /auth/google/failure
• Method: GET
• Description: Handles failed Google authentication. Returns an error message stating that the user is not authenticated.

• URL: /logout
• Method: GET
• Description: Logs out the current user. If the user has an active session, the session is destroyed. The user is then logged out, and a success message is returned.

• URL: /getuser
• Method: GET
• Headers: Authorization: Bearer <token>
• Description: Retrieves data for the current user. The user must be authenticated and provide a valid token in the Authorization header. If the user is found in the database, their data is returned. If the user is not found or not authenticated, an error message is returned.

5. Email Endpoints

The base URL for these endpoints is http://localhost:/email.

• URL: /send
• Method: POST
• Description: Send mails with attachments.
• Request Body:
  • emails: Array of email addresses to send mails to.
  • sender: Email address of the sender.
  • subject: Subject of the email.
  • text: Body of the email.
  • Files to be attached.

• URL: /mail
• GET Method: GET
• Description: Get all emails associated with a user.
• Query Parameters:
  • userEmail: Email address of the user.
• POST Method: POST
• Description: Add new email(s) to a user's account.
• Request Body:
  • userId: ID of the user.
  • data: Array of email objects containing the following fields:
    • email: Email address.
    • currentDesignation: Current designation (optional).
    • name: Name (optional).
    • company: Company (optional).
• DELETE Method: DELETE
• Description: Remove an email from a user's account.
• Request Body:
  • userId: ID of the user.
  • _id: ID of the email to remove.
• PUT Method: PUT
• Description: Update an existing email associated with a user.
• Request Body:
  • userId: ID of the user.
  • data: Object containing the following fields:
    • _id: ID of the email.
    • email: Email address.
    • currentDesignation: Current designation (optional).
    • name: Name (optional).
    • company: Company (optional).

• URL: /mail/store-mail
• Method: POST
• Description: Store email(s) in a user's account.
• Headers: Authorization: Bearer <token>
• Request Body:
  • emails: Array of email addresses to store.

Navigate to this Blog to read more about

For more examples, please refer to the Documentation

(back to top)

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)

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

(back to top)

1. Chahat sagar
2. Ayush Vishwakarma
3. Ritu Raj

Project Link: https://commu-net.vercel.app

(back to top)