Skip to content

Latest commit

 

History

History
237 lines (179 loc) · 10.9 KB

README.md

File metadata and controls

237 lines (179 loc) · 10.9 KB

Contributors Stargazers Mainabilities API Build Client Build


Logo

Newsltr

Effortlessly create, manage, and send newsletters tailored to your business.
Explore the docs »

View · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Newsltr Screenshot

Welcome to Newsltr, the next-generation SaaS platform for effortless newsletter management. Newsltr is designed to simplify the entire process of creating, distributing, and tracking newsletters. We understand that your time is valuable, and our goal is to empower you to focus on what matters most - crafting outstanding content and engaging with your audience.

Why Newsltr?

  • Streamlined Newsletter Creation: Say goodbye to the hassle of creating newsletters from scratch. Newsltr offers a wide range of professionally designed newsletter templates, making it easy to craft visually appealing content.

  • Powerful Analytics: Gain insights into the performance of your newsletters. Track open rates, click-through rates, and audience engagement, allowing you to refine your communication strategy.

  • Flexible Workspaces: Organize your newsletter projects efficiently using workspaces. Collaborate with team members and manage multiple newsletters seamlessly.

  • Plug-n-Play SDK: Easily integrate Newsltr into your applications and websites with our SDK. Quickly add newsletter signup forms and enhance user engagement. Made in TypeScript (more coming soon), our SDK is designed to be developer-friendly and easy to scale for other languages.

We believe in the "Don't Repeat Yourself" (DRY) principle, not only in code but also in life. With Newsltr, you'll eliminate the repetitive tasks associated with newsletter management, ensuring your projects are always up-to-date and efficient. The best confirmation is our innovative email templates system that allows you to create and manage your own templates. You can also use our pre-built templates to get started quickly. We are also planning to add AI-powered content generation in the future.

Our Commitment to Improvement: We understand that every project is unique, and your needs may evolve. That's why we are committed to continuously enhancing Newsltr. Expect more features and templates in the near future. Your feedback is invaluable, and you're welcome to contribute by forking this repository, creating pull requests, or opening issues.

Thank you to all the contributors who have played a part in expanding this platform. Together, we're making newsletter management easier and more effective.

Ready to get started? Visit our website to explore Newsltr, and let's transform the way you manage newsletters!

(back to top)

Built With

  • Next
  • Redux
  • Python
  • Django Rest Framework
  • PostgreSQL
  • Redis
  • Celery
  • Docker
  • Docker Compose
  • Kubernetes
  • Helm

(back to top)

Getting Started

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.

Prerequisites

This is an list of things you need to use the software for development purposes and how to install them.

Installation

Development

  1. Install Docker and Docker-compose
  2. Clone repository git clone https://github.com/style77/newsltr.git and cd newsltr/newsltr
  3. Run cp .env.example .env and fill in the environment variables
  4. Go back to the root directory with cd .. and run make up-dev to start the development API environment (this will take a while)
  5. Go to the client directory with cd ../client and run npm install to install the client dependencies and npm run dev to start the client

Production

Coming soon...

(back to top)

Roadmap

  • AI-powered content generation
  • More templates
  • More SDKs
    • TypeScript
    • Go

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. See CONTIBUTING for more information.

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 CC BY-NC-ND License. See LICENSE for more information.

(back to top)

Contact

Joachim Hodana (stylek777@gmail.com) and Mohamed Younes Abdat

Project Link: https://github.com/Style77/newsltr

(back to top)