README.md

About SubscriberSavant

SubscriberSavant is a tool for managing your email subscribers. It is a web application that allows you to manage your subscribers It is built on the Laravel PHP framework and uses Bootstrap for the front-end. And for now its implemented with Mailerlite API.

Installation

Requirements

Basic requirements as needed Laravel 8.75.

Installation

1. Clone the repository git clone https://github.com/nayeemdev/SubscriberSavant
2. Install the dependencies composer install
3. Copy the .env.example file to .env and fill in the database credentials
4. Generate application key php artisan key:generate
5. Import the database file database/sql/database.sql to your database
6. Get your Mailerlite API key from here - Mailerlite
7. Run the application php artisan serve
8. Visit http://localhost:8000 in your browser
9. Set your Mailerlite API key in the integration page

Extra Directory Explanation

app/DTO/ - Contains the Data Transfer Objects
app/Library/ - Contains the Mailerlite API library
app/Services/ - Contains the service classes
database/sql/ - Contains the database file

Features

• Validating and saving an API key
• Listing all the subscribers
• Adding a new subscriber
• Updating an existing subscriber
• Deleting a subscriber
• Searching a subscriber

Testing

In order to run the tests, you need to run the following command: php artisan test

There are 2 tests file for Subscriber API and Integration. Subscriber API is unit test and other is feature test.

Screenshots