Giter Site home page Giter Site logo

phplist / phplist-ui-bootlist Goto Github PK

View Code? Open in Web Editor NEW
10.0 10.0 12.0 11.2 MB

phpList 3 theme with bootstrap

License: GNU General Public License v3.0

CSS 19.44% HTML 64.81% PHP 1.71% JavaScript 11.67% Ruby 0.10% PowerShell 0.03% Hack 0.10% Pug 0.12% Less 2.02%
bootstrap

phplist-ui-bootlist's Introduction

phpList core module

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

About phpList

phpList is an open source newsletter manager. This project is a rewrite of the original phpList.

About this package

This is the core module of the successor to phpList 3. It will have the following responsibilities:

  • provide access to the DB via Doctrine models and repositories (and raw SQL for performance-critical parts that do not need the models)
  • routing (which the web frontend and REST API will use)
  • authentication (which the web frontend and REST API will use)
  • logging
  • a script for tasks to be called from the command line (or a cron job)
  • tasks to create and update the DB schema

Please note that this module does not provide a web frontend or a REST API. There are the separate modules phpList/web-frontend and phpList/rest-api for these tasks.

This module should not be modified locally. It should be updated via Composer.

Installation

Since this package is only a service required to run a full installation of phpList 4, the recommended way of installing this package is to run composer install from within the phpList base distribution which requires this package. phpList/base-distribution containrs detailed installation instructions in its README.

Contributing to this package

Contributions to phpList repositories are highly welcomed! To get started please take a look at the contribution guide. It contains everything you would need to make your first contribution including how to run local style checks and run tests.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.

Structure

Running the web server

The phpList application is configured so that the built-in PHP web server can run in development and testing mode, while Apache can run in production mode.

Please first set the database credentials in config/parameters.yml.

Development

To run the application in development mode using PHP's built-in server, use this command:

bin/console server:run -d public/

The server will then listen on http://127.0.0.1:8000 (or, if port 8000 is already in use, on the next free port after 8000).

You can stop the server with CTRL + C.

Development and Documentation

We use phpDocumentor to automatically generate documentation for classes. To make this process efficient and easier, you are required to properly "document" your classes,properties, methods ... by annotating them with docblocks.

More about generatings docs in PHPDOC.md

Testing

To run the server in testing mode (which normally will only be needed for the automated tests, provide the --env option:

bin/console server:run -d public/ --env=test

Production

For documentation on running the application in production mode using Apache, please see the phpList base distribution README.

Changing the database schema

Any changes to the database schema must always be done both in phpList 3 and later versions so that both versions always have the same schema.

For changing the database schema, please edit resources/Database/Schema.sql and adapt the corresponding domain model classes and repository classes accordingly.

Developing phpList modules (plugins)

In phpList, plugins are called modules. They are Composer packages which have the type phplist-module.

Bundle and route configuration

If your module provides any Symfony bundles, the bundle class names need to be listed in the extra section of the module's composer.json like this:

"extra": {
    "phplist/core": {
        "bundles": [
            "Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle",
            "PhpList\\Core\\EmptyStartPageBundle\\PhpListEmptyStartPageBundle"
        ]
    }
}

Please note that the key of the section with extra needs to always be phplist/core, not the name of your module package. Please have a look at the composer.json in the rest-api module for an example.

Similarly, if your module provides any routes, those also need to be listed in the extra section of the module's composer.json like this:

"extra": {
    "phplist/core": {
        "routes": {
            "homepage": {
                "resource": "@PhpListEmptyStartPageBundle/Controller/",
                "type": "annotation"
            }
        }
    }
}

You can also provide system configuration for your module:

"extra": {
    "phplist/core": {
        "configuration": {
            "framework": {
                "templating": {
                    "engines": [
                        "twig"
                    ]
                }
            }
        }
    }
}

It is recommended to define the routes using annotations in the controller classes so that the route configuration in the composer.json is minimal.

Accessing the database

For accessing the phpList database tables from a module, please use the Doctrine model and repository classes stored in src/Domain/ in the phplist/core package (this package).

For accessing a repository, please have it injected via dependency injection. Please do not get the repository directly from the entity manager as this would skip dependency injection for that repository, causing those methods to break that rely on other services having been injected.

Currently, only a few database tables are mapped as models/repositories. If you need a mode or a repository method that still is missing, please submit a pull request or file an issue.

Accessing the phpList data from third-party applications

To access the phpList data from a third-party application (i.e., not from a phpList module), please use the REST API.

Copyright

phpList is copyright (C) 2000-2021 phpList Ltd.

phplist-ui-bootlist's People

Contributors

bramley avatar brunildadosti avatar dependabot[bot] avatar marianaballa avatar mariez avatar mfettig avatar michield avatar patriot1889 avatar samtuke avatar suelap avatar tarekdj avatar xh3n1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

phplist-ui-bootlist's Issues

How to style an a element as a button

In Dressprow there is a "button" CSS class that styles an <a> element as a button. The result looks just the same as a submit button.

There doesn't appear to be the same class in Trevellin, so is there anything else common to both themes that will do this?
Currently in Trevellin this link appears as a button but with a different background colour to real submit buttons. The styling appears to be done for btn and btn-default classes, so something is changing the button class into those classes.

<input name="segment[save]" type="submit" value="Save segment" /> </div> <div class="segment-block">

<a target="_blank" class="button" href="./?page=configure&amp;tk=fc5c19e4302b3341470274da4fb7ecda#segmentation">Edit saved segments</a>
image

Incompatible with phpList plugins which use local copies of jQuery

phpList plugins which already include their own copy of jQuery are incompatible with this theme. The segmentation plugin (https://github.com/bramley/phplist-plugin-segment) for example, uses jQuery for forms on it's "Segmentation" tab in the campaign composer. This conflict must be resolved.
A possible solution could be a new policy on phpList plugin use of jQuery, with clear documentation on what jQuery version and jQuery plugins the bootlist theme supports and makes available to plugins used with it.

Not using the updated community rss feed code

This theme doesn't have the changes made to the dressprow theme to fix the response problems with the community rss feed.

It would seem sensible to move the bulk of that rss feed processing into core phplist with the themes dealing only with the presentation (css etc).

Missing lists when adding emails

I saw this was reported a while ago, but i am unable to get it working, even after the commits you have made of late. when adding emails via copy & paste, the Lists dialog is hidden by default. this is the div: "

    ".

    i know this was reported as a bug on mobile at the beginning of this year, but i get it on FF, chrome and safari on mac.

Incompatible to 3.2.5 or still very WIP?

I build this (npm install -g grunt-cli && npm install) and put it to /lists/admin/ui/phplist-ui-bootstrap and pointed init.php to this theme.

It looks a bit messed up, eg. the tabs on the start page appear over the content.
There was no issue in the browser console, and the issue apperared in different browsers I tested.

Did I miss anything in the installation process?

screen1
screen2

Webbler listing column is displayed as a button

With this theme when using a Webbler listing, a column whose value has a link is displayed as a kind of button. Some classes are added to the <a> element by javascript - btn btn-xs and btn-primary which appear to be responsible for the styling.
image

Is there some way to stop this happening so that the column content is displayed similarly to the ID column in the screenshot? For comparison the Dressprow theme styles the ID and Campaign columns the same
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.