Category: Blog

  • meta

    Header-only runtime reflection system in C++

    GitHub version Build Status Coverage Donate

    The reflection system was born within EnTT and is developed and enriched there. This project is designed for those who are interested only in a header-only, full-featured, non-intrusive and macro free reflection system which certainly deserves to be treated also separately due to its quality and its rather peculiar features.

    If you use meta and you want to say thanks or support the project, please consider becoming a sponsor.
    You can help me make the difference. Many thanks to those who supported me and still support me today.

    Table of Contents

    Introduction

    Reflection (or rather, its lack) is a trending topic in the C++ world. I looked for a third-party library that met my needs on the subject, but I always came across some details that I didn’t like: macros, being intrusive, too many allocations.
    In one word: unsatisfactory.

    I finally decided to write a built-in, non-intrusive and macro-free runtime reflection system for my own.
    Maybe I didn’t do better than others or maybe yes. Time will tell me.

    Build Instructions

    Requirements

    To be able to use meta, users must provide a full-featured compiler that supports at least C++17.
    The requirements below are mandatory to compile the tests and to extract the documentation:

    • CMake version 3.2 or later.
    • Doxygen version 1.8 or later.

    If you are looking for a C++14 version of meta, feel free to contact me.

    Library

    meta is a header-only library. This means that including the factory.hpp and meta.hpp headers is enough to include the library as a whole and use it.
    It’s a matter of adding the following lines to the top of a file:

    #include <meta/factory.hpp>
    #include <meta/meta.hpp>

    Then pass the proper -I argument to the compiler to add the src directory to the include paths.

    Documentation

    The documentation is based on doxygen. To build it:

    $ cd build
    $ cmake .. -DBUILD_DOCS=ON
    $ make
    

    The API reference will be created in HTML format within the directory build/docs/html. To navigate it with your favorite browser:

    $ cd build
    $ your_favorite_browser docs/html/index.html
    

    It’s also available online for the latest version.

    Tests

    To compile and run the tests, meta requires googletest.
    cmake will download and compile the library before compiling anything else. In order to build without tests set CMake option BUILD_TESTING=OFF.

    To build the most basic set of tests:

    • $ cd build
    • $ cmake ..
    • $ make
    • $ make test

    Crash course

    Names and identifiers

    The meta system doesn’t force the user to use a specific tool when it comes to working with names and identifiers. It does this by offering an API that works with opaque identifiers that for example may or may not be generated by means of a hashed string.
    This means that users can assign any type of identifier to the meta objects, as long as they are numeric. It doesn’t matter if they are generated at runtime, at compile-time or with custom functions.

    However, the examples in the following sections are all based on std::hash<std::string_view> as provided by the standard library. Therefore, where an identifier is required, it’s likely that an instance of this class is used as follows:

    std::hash<std::string_view> hash{};
    auto factory = meta::reflect<my_type>(hash("reflected_type"));

    For what it’s worth, this is likely completely equivalent to:

    auto factory = meta::reflect<my_type>(42);

    Obviously, human-readable identifiers are more convenient to use and highly recommended.

    Reflection in a nutshell

    Reflection always starts from real types (users cannot reflect imaginary types and it would not make much sense, we wouldn’t be talking about reflection anymore).
    To reflect a type, the library provides the reflect function:

    meta::factory factory = meta::reflect<my_type>(hash("reflected_type"));

    It accepts the type to reflect as a template parameter and an optional identifier as an argument. Identifiers are important because users can retrieve meta types at runtime by searching for them by name. However, there are cases in which users can be interested in adding features to a reflected type so that the reflection system can use it correctly under the hood, but they don’t want to allow searching the type by name.
    In both cases, the returned value is a factory object to use to continue building the meta type.

    A factory is such that all its member functions returns the factory itself. It can be used to extend the reflected type and add the following:

    • Constructors. Actual constructors can be assigned to a reflected type by specifying their list of arguments. Free functions (namely, factories) can be used as well, as long as the return type is the expected one. From a client’s point of view, nothing changes if a constructor is a free function or an actual constructor.
      Use the ctor member function for this purpose:

      meta::reflect<my_type>(hash("reflected")).ctor<int, char>().ctor<&factory>();
    • Destructors. Free functions can be set as destructors of reflected types. The purpose is to give users the ability to free up resources that require special treatment before an object is actually destroyed.
      Use the dtor member function for this purpose:

      meta::reflect<my_type>(hash("reflected")).dtor<&destroy>();

      A function should neither delete nor explicitly invoke the destructor of a given instance.

    • Data members. Both real data members of the underlying type and static and global variables, as well as constants of any kind, can be attached to a meta type. From a client’s point of view, all the variables associated with the reflected type will appear as if they were part of the type itself.
      Use the data member function for this purpose:

      meta::reflect<my_type>(hash("reflected"))
          .data<&my_type::static_variable>(hash("static"))
          .data<&my_type::data_member>(hash("member"))
          .data<&global_variable>(hash("global"));

      This function requires as an argument the identifier to give to the meta data once created. Users can then access meta data at runtime by searching for them by name.
      Data members can be set also by means of a couple of functions, namely a setter and a getter. Setters and getters can be either free functions, member functions or mixed ones, as long as they respect the required signatures.
      Refer to the inline documentation for all the details.

    • Member functions. Both real member functions of the underlying type and free functions can be attached to a meta type. From a client’s point of view, all the functions associated with the reflected type will appear as if they were part of the type itself.
      Use the func member function for this purpose:

      meta::reflect<my_type>(hash("reflected"))
          .func<&my_type::static_function>(hash("static"))
          .func<&my_type::member_function>(hash("member"))
          .func<&free_function>(hash("free"));

      This function requires as an argument the identifier to give to the meta function once created. Users can then access meta functions at runtime by searching for them by name.

    • Base classes. A base class is such that the underlying type is actually derived from it. In this case, the reflection system tracks the relationship and allows for implicit casts at runtime when required.
      Use the base member function for this purpose:

      meta::reflect<derived_type>(hash("derived")).base<base_type>();

      From now on, wherever a base_type is required, an instance of derived_type will also be accepted.

    • Conversion functions. Actual types can be converted, this is a fact. Just think of the relationship between a double and an int to see it. Similar to bases, conversion functions allow users to define conversions that will be implicitly performed by the reflection system when required.
      Use the conv member function for this purpose:

      meta::reflect<double>().conv<int>();

    That’s all, everything users need to create meta types and enjoy the reflection system. At first glance it may not seem that much, but users usually learn to appreciate it over time.
    Also, do not forget what these few lines hide under the hood: a built-in, non-intrusive and macro-free system for reflection in C++. Features that are definitely worth the price, at least for me.

    Any as in any type

    The reflection system comes with its own meta any type. It may seem redundant since C++17 introduced std::any, but it is not.
    In fact, the type returned by an std::any is a const reference to an std::type_info, an implementation defined class that’s not something everyone wants to see in a software. Furthermore, the class std::type_info suffers from some design flaws and there is even no way to convert an std::type_info into a meta type, thus linking the two worlds.

    A meta any object provides an API similar to that of its most famous counterpart and serves the same purpose of being an opaque container for any type of value.
    It minimizes the allocations required, which are almost absent thanks to SBO techniques. In fact, unless users deal with fat types and create instances of them though the reflection system, allocations are at zero.

    A meta any object can be created by any other object or as an empty container to initialize later:

    // a meta any object that contains an int
    meta::any any{0};
    
    // an empty meta any object
    meta::any empty{};

    It takes the burden of destroying the contained instance when required.
    Moreover, it can be used as an opaque container for unmanaged objects if needed:

    int value;
    meta::any any{std::ref(value)};

    In other words, whenever any intercepts a reference_wrapper, it acts as a reference to the original instance rather than making a copy of it. The contained object is never destroyed and users must ensure that its lifetime exceeds that of the container.

    A meta any object has a type member function that returns the meta type of the contained value, if any. The member functions try_cast, cast and convert are used to know if the underlying object has a given type as a base or if it can be converted implicitly to it.

    Enjoy the runtime

    Once the web of reflected types has been constructed, it’s a matter of using it at runtime where required.

    To search for a reflected type there are two options: by type or by name. In both cases, the search can be done by means of the resolve function:

    // search for a reflected type by type
    meta::type by_type = meta::resolve<my_type>();
    
    // search for a reflected type by name
    meta::type by_name = meta::resolve(hash("reflected_type"));

    There exits also a third overload of the resolve function to use to iterate all the reflected types at once:

    resolve([](meta::type type) {
        // ...
    });

    In all cases, the returned value is an instance of type. This type of objects offer an API to know the runtime identifier of the type, to iterate all the meta objects associated with them and even to build or destroy instances of the underlying type.
    Refer to the inline documentation for all the details.

    The meta objects that compose a meta type are accessed in the following ways:

    • Meta constructors. They are accessed by types of arguments:

      meta::ctor ctor = meta::resolve<my_type>().ctor<int, char>();

      The returned type is ctor and may be invalid if there is no constructor that accepts the supplied arguments or at least some types from which they are derived or to which they can be converted.
      A meta constructor offers an API to know the number of arguments, the expected meta types and to invoke it, therefore to construct a new instance of the underlying type.

    • Meta destructor. It’s returned by a dedicated function:

      meta::dtor dtor = meta::resolve<my_type>().dtor();

      The returned type is dtor and may be invalid if there is no custom destructor set for the given meta type.
      All what a meta destructor has to offer is a way to invoke it on a given instance. Be aware that the result may not be what is expected.

    • Meta data. They are accessed by name:

      meta::data data = meta::resolve<my_type>().data(hash("member"));

      The returned type is data and may be invalid if there is no meta data object associated with the given identifier.
      A meta data object offers an API to query the underlying type (ie to know if it’s a const or a static one), to get the meta type of the variable and to set or get the contained value.

    • Meta functions. They are accessed by name:

      meta::func func = meta::resolve<my_type>().func(hash("member"));

      The returned type is func and may be invalid if there is no meta function object associated with the given identifier.
      A meta function object offers an API to query the underlying type (ie to know if it’s a const or a static function), to know the number of arguments, the meta return type and the meta types of the parameters. In addition, a meta function object can be used to invoke the underlying function and then get the return value in the form of meta any object.

    • Meta bases. They are accessed through the name of the base types:

      meta::base base = meta::resolve<derived_type>().base(hash("base"));

      The returned type is base and may be invalid if there is no meta base object associated with the given identifier.
      Meta bases aren’t meant to be used directly, even though they are freely accessible. They expose only a few methods to use to know the meta type of the base class and to convert a raw pointer between types.

    • Meta conversion functions. They are accessed by type:

      meta::conv conv = meta::resolve<double>().conv<int>();

      The returned type is conv and may be invalid if there is no meta conversion function associated with the given type.
      The meta conversion functions are as thin as the meta bases and with a very similar interface. The sole difference is that they return a newly created instance wrapped in a meta any object when they convert between different types.

    All the objects thus obtained as well as the meta types can be explicitly converted to a boolean value to check if they are valid:

    meta::func func = meta::resolve<my_type>().func(hash("member"));
    
    if(func) {
        // ...
    }

    Furthermore, all meta objects with the exception of meta destructors can be iterated through an overload that accepts a callback through which to return them. As an example:

    meta::resolve<my_type>().data([](meta::data data) {
        // ...
    });

    A meta type can also be used to construct or destroy actual instances of the underlying type.
    In particular, the construct member function accepts a variable number of arguments and searches for a match. It returns a any object that may or may not be initialized, depending on whether a suitable constructor has been found or not. On the other side, the destroy member function accepts instances of any as well as actual objects by reference and invokes the registered destructor if any.
    Be aware that the result of a call to destroy may not be what is expected. The purpose is to give users the ability to free up resources that require special treatment and not to actually destroy instances.

    Meta types and meta objects in general contain much more than what is said: a plethora of functions in addition to those listed whose purposes and uses go unfortunately beyond the scope of this document.
    I invite anyone interested in the subject to look at the code, experiment and read the official documentation to get the best out of this powerful tool.

    Policies: the more, the less

    Policies are a kind of compile-time directives that can be used when recording reflection information.
    Their purpose is to require slightly different behavior than the default in some specific cases. For example, when reading a given data member, its value is returned wrapped in a any object which, by default, makes a copy of it. For large objects or if the caller wants to access the original instance, this behavior isn’t desirable. Policies are there to offer a solution to this and other problems.

    There are a few alternatives available at the moment:

    • The as-is policy, associated with the type meta::as_is_t.
      This is the default policy. In general, it should never be used explicitly, since it’s implicitly selected if no other policy is specified.
      In this case, the return values of the functions as well as the properties exposed as data members are always returned by copy in a dedicated wrapper and therefore associated with their original meta types.

    • The as-void policy, associated with the type meta::as_void_t.
      Its purpose is to discard the return value of a meta object, whatever it is, thus making it appear as if its type were void.
      If the use with functions is obvious, it must be said that it’s also possible to use this policy with constructors and data members. In the first case, the constructor will be invoked but the returned wrapper will actually be empty. In the second case, instead, the property will not be accessible for reading.

      As an example of use:

      meta::reflect<my_type>(hash("reflected"))
          .func<&my_type::member_function, meta::as_void_t>(hash("member"));
    • The as-alias policy, associated with the type meta::as_alias_t
      It allows to build wrappers that act as aliases for the objects used to initialize them. Modifying the object contained in the wrapper for which the aliasing was requested will make it possible to directly modify the instance used to initialize the wrapper itself.
      This policy works with constructors (for example, when objects are taken from an external container rather than created on demand), data members and functions in general (as long as their return types are lvalue references).

      As an example of use:

      meta::reflect<my_type>(hash("reflected"))
          .data<&my_type::data_member, meta::as_alias_t>(hash("member"));

    Some uses are rather trivial, but it’s useful to note that there are some less obvious corner cases that can in turn be solved with the use of policies.

    Named constants and enums

    A special mention should be made for constant values and enums. It wouldn’t be necessary, but it will help distracted readers.

    As mentioned, the data member function can be used to reflect constants of any type among the other things.
    This allows users to create meta types for enums that will work exactly like any other meta type built from a class. Similarly, arithmetic types can be enriched with constants of special meaning where required.
    Personally, I find it very useful not to export what is the difference between enums and classes in C++ directly in the space of the reflected types.

    All the values thus exported will appear to users as if they were constant data members of the reflected types.

    Exporting constant values or elements from an enum is as simple as ever:

    meta::reflect<my_enum>()
            .data<my_enum::a_value>(hash("a_value"))
            .data<my_enum::another_value>(hash("another_value"));
    
    meta::reflect<int>().data<2048>(hash("max_int"));

    It goes without saying that accessing them is trivial as well. It’s a matter of doing the following, as with any other data member of a meta type:

    my_enum value = meta::resolve<my_enum>().data(hash("a_value")).get({}).cast<my_enum>();
    int max = meta::resolve<int>().data(hash("max_int")).get({}).cast<int>();

    As a side note, remember that all this happens behind the scenes without any allocation because of the small object optimization performed by the meta any class.

    Properties and meta objects

    Sometimes (for example, when it comes to creating an editor) it might be useful to be able to attach properties to the meta objects created. Fortunately, this is possible for most of them.
    To attach a property to a meta object, no matter what as long as it supports properties, it is sufficient to provide an object at the time of construction such that std::get<0> and std::get<1> are valid for it. In other terms, the properties are nothing more than key/value pairs users can put in an std::pair. As an example:

    meta::reflect<my_type>(hash("reflected"), std::make_pair(hash("tooltip"), "message"));

    The meta objects that support properties offer then a couple of member functions named prop to iterate them at once and to search a specific property by key:

    // iterate all the properties of a meta type
    meta::resolve<my_type>().prop([](meta::prop prop) {
        // ...
    });
    
    // search for a given property by name
    meta::prop prop = meta::resolve<my_type>().prop(hash("tooltip"));

    Meta properties are objects having a fairly poor interface, all in all. They only provide the key and the value member functions to be used to retrieve the key and the value contained in the form of meta any objects, respectively.

    Unregister types

    A type registered with the reflection system can also be unregistered. This means unregistering all its data members, member functions, conversion functions and so on. However, the base classes won’t be unregistered, since they don’t necessarily depend on it. Similarly, implicitly generated types (as an example, the meta types implicitly generated for function parameters when needed) won’t be unregistered.

    To unregister a type, users can use the unregister function from the global namespace:

    meta::unregister<my_type>();

    This function returns a boolean value that is true if the type is actually registered with the reflection system, false otherwise.
    The type can be re-registered later with a completely different name and form.

    Contributors

    Requests for features, PR, suggestions ad feedback are highly appreciated.

    If you find you can help me and want to contribute to the project with your experience or you do want to get part of the project for some other reasons, feel free to contact me directly (you can find the mail in the profile).
    I can’t promise that each and every contribution will be accepted, but I can assure that I’ll do my best to take them all seriously.

    If you decide to participate, please see the guidelines for contributing before to create issues or pull requests.
    Take also a look at the contributors list to know who has participated so far.

    License

    Code and documentation Copyright (c) 2018-2019 Michele Caini.

    Code released under the MIT license. Documentation released under CC BY 4.0.

    Support

    If you want to support this project, you can offer me an espresso.
    If you find that it’s not enough, feel free to help me the way you prefer.

    Visit original content creator repository
  • ZPM

    ZPM is the C++ package manager built for everyone who uses premake!
    We designed it to make it easy to use libraries, modules and assets.

    PLEASE NOTE: THIS PROJECT IS IN BETA

    Status

    OS Status
    Linux & OSX Build Status
    Windows Build status

    #Documentation The complete documentation can be found here.

    Why ZPM?

    • Easy, cross-platform package manager
    • Integrates with premake5
    • Both for using and publishing packages.
    • All Git repositories supported, even private repositories.
    • For packages, premake5 modules, and assets.
    • Assets may be hosted using Git LFS, and from urls.
    • Optionally separating the ZPM package and build files.
    • Git tags for versioning.

    Bugs

    When a bug is found, please insert it in the issue tracker, so we can resolve it as quickly as we can.

    Contributing

    1. Fork it!
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request

    License

    This project is licensed under the MIT license by Zefiros Software.

    Copyright (c) 2017 Zefiros Software.
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
    
    Visit original content creator repository
  • AECOPD

    How to: find acute exacerbation of chronic obstructive pulmonary disease (AECOPD) events in UK primary care electronic healthcare records (EHRs)

    AECOPD algorithm (Rothnie et al., 2016)

    The Algorithms with PPV > 75% shown below represent the best AECOPD detection method in UK primary care EHRs.

    In summary, an AECOPD can be in found in primary care EHRs by excluding any events on a COPD annual review day and searching for any of the following events:

    Any of these events closer together than 14 days are considered part of the same exacerbation event.

    *Prescription duration is poorly recorded in CPRD Aurum, therefore any day where a patient receives a prescription for both an antibiotic and oral corticosteroid is counted as an exacerbation event.

    Example Stata code

    The do file containing this code as well as the annual_review, AECOPD_symptoms, LRTI, AECOPD, and antibiotics_ocs codelists can be found in the parent directory of this repository.

    1. Set working directory. In this example I have assumed that all data files and codelists are in the same working directory.

    cd "<path to codelists and data files>"

    2. Open clinical events file, e.g. “Observation” file in CPRD Aurum.

    use Observation, clear

    3. Merge events file with SNOMED CT codelists to get clinical events of interest.

    merge 1:1 snomedctdescriptionid using annual_review.csv, nogenerate keep(match master)
    merge 1:1 snomedctdescriptionid using AECOPD_symptoms.csv, nogenerate keep(match master)
    merge 1:1 snomedctdescriptionid using LRTI.csv, nogenerate keep(match master)
    merge 1:1 snomedctdescriptionid using AECOPD.csv, nogenerate keep(match master)

    4. Just keep clinical events of interest.

    drop if copd_annualreview == . & breathlessness == . & cough == . & sputum == . & lrti == . & aecopd == .

    5. Save temporary file containing clinical events of interest.

    tempfile review_symptoms_LRTI_AECOPD
    save `review_symptoms_LRTI_AECOPD'

    6. Open prescription events file, e.g. “DrugIssue” file in CPRD Aurum.

    use DrugIssue, clear

    7. Merge prescription file with DM+D codelists to get prescription events of interest.

    merge 1:1 snomedctdescriptionid using `antibiotics_ocs', nogenerate keep(match master)

    8. Just keep prescription events of interest.

    drop if antibiotic == . & oral_corticosteroid == .

    9. Rename date of prescription variable to have the same name as date of clinical event variable so that date of prescription or event are represented with just one variable.

    rename issuedate obsdate

    10. Append clinical event data to prescription event date to obtain all events of interest in one file.

    append using `review_symptoms_LRTI_AECOPD'

    11. Sort new combined clinical and prescription event file by date fore each patient so that older events are listed first.

    gsort patid obsdate

    12. Collapse data by patient and date to get all events on the same day.

    collapse (max) annual_review antibiotic oral_corticosteroid breathlessness cough sputum lrti aecopd, by(patid obsdate)

    13. Remove events on an annual review day.

    drop if annual_review == 1
    drop annual_review

    14. Calculate total number of symptoms on a specific day.

    egen symptoms = rowtotal(breathlessness cough sputum)
    order symptoms, after(sputum)

    15. Only keep days where both antibiotics and oral corticosteroids were prescribed, days where a patient had 2 or more symptoms and an antibiotic or oral corticosteroid prescribed, days where a patient received an AECOPD code, or days where a patient received a LRTI code.

    keep if (abx == 1 & ocs == 1) ///
    	  | (symptoms >= 2 & (abx == 1 | ocs == 1)) ///
    	  | aecopd == 1 ///
    	  | lrti == 1

    16. Count any day with the events above as an exacerbation, excluding events closer together than 14 days.

    by patid: gen exacerbation = 1 if _n == 1 | obsdate[_n-1] < obsdate-14

    17. You now have a list of exacerbations for each patient. If you run the collapse command you can generate the total number of exacerbations for each patient over the given time peroid.

    collapse (sum) exacerbations=exacerbation, by(patid)

    Visit original content creator repository

  • js-framework-comparison

    JS Framework Comparison of size of built apps

    GitHub language count GitHub top language

    Comparison of size of

    1. Built apps and minified JS
    2. Size of development folders
    3. Expressiveness and Simplicity of syntax

    For some of the most used Javascript Framework.

    For each framework is developed a small application that handles a counter and a list that can be dynamically appended and cleared by UI.

    The well-known JS web frameworks benchmark conducted by Krausest focuses on CPU speed execution, Lighthouse mobile simulation, and memory allocation. While it is valuable to understand the performance of the framework we are working with or considering, an important factor to consider is the size of the final built bundle that contains minified JS code. Nowadays, most devices can easily handle complex websites. However, websites are often refreshed frequently, sometimes with every page change by the user. This raises the issue of the web application’s size, as it affects page loading speed, file interpretation speed, user experience, and network traffic. It is desirable to keep the bundled website as small as possible to minimize network traffic and ensure the best possible user experience in terms of loading time. This project analyzes the sizes of the minified JS bundles for the same simple web application in some of the most commonly used JS frameworks.

    Results

    React create-react-app React vite Angular Preact Vite Svelte Vue vite Solid Qwik Vanilla JS
    Size of built JS (KB) 531 140 138 13.7 6.73 53.6 9.96 54.0 1.11
    Size of dev folder (KB) 292 511 102 757 481 411 70 761 103 418 107 088 96 100 168 932 3.6
    Version 18.2.0 18.2.0 14.2.3 10.13.1 3.55.1 3.2.45 1.6.10 0.20.1

    Size of minified JS bundle in KB

    Lower is better

    Comparison Chart

    Qwik is a little bit different because all js is not interpreted after the page is rendered, though the minimum bundle size remains large (42.5 KB).

    Size of development folder in MB

    Including node modules

    Lower is better

    Comparison Chart

    Expressiveness and Simplicity of syntax

    In my opinion:

    • Svelte and Vue (using Components API) wins the battle, they provides the simplest and most declarative syntax.
    • Angular has also a pretty clean syntax on top of a nice organisation of components. Though, it can result in a lot of src files to handle.
    • React and Solid components return JSX that contains JavaScript expression, this focus on more and smaller reusable components (especially compared to Angular components), but have the drawback to mix HTML and JS code together, so it can be confusing, and the MVC is hard to achieve.

    In any case, vanilla JS is to be avoided for any kind of projects.

    Details on each framework

    Solid

    • Size of development folder: 91.6 MB

    • Contains:

      • Files: 2307
      • Folders: 361
    • Size of built app: 27.7 KB

    • Size of minified JS files: 9.96 KB

    • Components: functions that returns JSX or TSX

    • State: const [a, setA] = createSignal('val');

    • Primitives: createEffect(() => console.log(a + ' updated')); and const aa: Type = createMemo(() => a + a;

    npm i

    npm run dev

    npm run build

    Svelte

    • Size of development folder: 98.6 MB

    • Contains:

      • Files: 1535
      • Folders: 341
    • Size of built app: 9.78 KB

    • Size of minified JS files: 6.73 KB

    • Components: .svelte file separating script, template and style

    • State: let a: Type = 'val';

    • Primitives: $: console.log(a + ' updated')); Simplest and cleanest syntax so far

    npm i

    npm run dev

    npm run build

    Vue

    • Size of development folder: 102 MB

    • Contains:

      • Files: 3267
      • Folders: 499
    • Size of built app: 59,2 KB

    • Size of minified JS files: 53,6 KB

    • Components: .vue file separating script, template and style. I used components API

    • State: let a: Type = 'val';

    npm i

    npm run dev

    npm run build

    Angular

    • Size of development folder: 459 MB

    • Contains:

      • Files: 40942
      • Folders: 3676
    • Size of built app: 153 KB

    • Size of minified JS files: 138 KB

    • Components: generated folder containing 4 files, model and controler is a TypeScript class

    • State: a: Type = 'val'; as a class attribute (in ts file, need to access them with this keyword)

    • Primitives: Not native to Angular, pretty verbose

    npm i

    ng s

    ng build --configuration production

    React (create-react-app)

    • Size of development folder: 278 MB

    • Contains:

      • Files: 36800
      • Folders: 34805
    • Size of built app: 540 KB

    • Size of minified JS files: 531 KB

    • Components: JSX or TSX files, function that returns JSX

    • State: const [a, setA] = useState<Type>('val'); as a class attribute

    npm i

    npm start

    npm run build

    React (npm init vite@latest)

    • Size of development folder: 97.9 MB
    • Contains:
      • Files: 2254
      • Folders: 320
    • Size of built app: 144 KB
    • Size of minified JS files: 140 KB

    npm i

    npm run dev

    npm run build

    Preact (vite)

    • Size of development folder: 70.8 MB
    • Contains:
      • Files: 2452
      • Folders: 373
    • Size of built app: 18.8 KB
    • Size of minified JS files: 13.7 KB

    npm i

    npm run dev

    npm run build

    Qwik

    • Size of development folder: 97.9 MB
    • Contains:
      • Files: 6187
      • Folders: 969
    • Size of built app: 75.1 KB
    • Size of minified JS files: 54 KB

    npm i

    npm start

    npm run build

    I used SSG (Static Site Generation) for this Qwik project npm run qwik add

    Vanilla JS

    • Size of development folder: 3.50 KB

    • Contains:

      • Files: 4
      • Folders: 1
    • Size of built app: 3.50 KB

    • Size of JS: 1.11 KB

    • Components: import js files

    • State: need to work with the DOM

    • Primitives: need to code one’s own framework

    Expressiveness

    Here I put side to side all code to manage the list (creation, push, empty)

    Angular

    <input type="text" (change)="sendMessage($event)" />
    <app-message *ngFor="let elem of list" [message]="elem"></app-message>
    <button (click)="emptyList()">Empty</button>
    import { Component } from '@angular/core';
    import { OnChange } from 'property-watch-decorator';
    
    export class AppComponent {
      LS: string = "jsFrameworkComparison-angular-messages";
    
      list: Message[] = [];
    
      ngOnInit() {
        this.list = JSON.parse(window.localStorage.getItem(this.LS) ?? "[]") as Message[];
      }
    
      sendMessage(event: any) {
        this.list.push({ message: event.target.value, date: new Date() });
        window.localStorage.setItem(this.LS, JSON.stringify(this.list));
      }
    
      emptyList() {
        this.list = [];
        window.localStorage.setItem(this.LS, "[]");
      }
    }
    
    export type Message = {
      message: string;
      date: Date;
    };

    Svelte

    <script lang="ts">
      import MessageComponent from "./components/MessageComponent.svelte";
    
      const LS: string = "jsFrameworkComparison-svelte-messages";
      let list: Message[] = [];
      list = JSON.parse(window.localStorage.getItem(LS) ?? "[]") as Message[];
    
      function sendMessage(event: any) {
        list.push({ message: event.target.value, date: new Date() });
        list = list;
        window.localStorage.setItem(LS, JSON.stringify(list));
      }
    
      function emptyList() {
        list = [];
        window.localStorage.setItem(LS, "[]");
      }
    
      type Message = {
        message: string;
        date: Date;
      };
    </script>
    
    <input type="text" on:change={(event) => sendMessage(event)} />
    {#each list as elem}
      <MessageComponent message={elem} />
    {/each}
    <button on:click={() => emptyList()}>Empty</button>

    Vue

    <script setup lang="ts">
    import { ref, type Ref } from 'vue';
    import MessageComponent from './components/MessageComponent.vue';
    
    const LS: string = "jsFrameworkComparison-vue-messages";
    let list: Ref<Message[]> = ref([]);
    list.value = JSON.parse(window.localStorage.getItem(LS) ?? "[]") as Message[];
    
    function sendMessage(event: any) {
      list.value.push({ message: event.target.value, date: new Date() });
      window.localStorage.setItem(LS, JSON.stringify(list.value));
    }
    
    function emptyList() {
      list.value = [];
      window.localStorage.setItem(LS, "[]");
    }
    
    type Message = {
      message: string;
      date: Date;
    };
    </script>
    
    <template>
          <input type="text" @change="(event) => sendMessage(event)" />
          <MessageComponent v-for="elem in list" :message="elem" />
          <button @click="() => emptyList()">Empty</button>
    </template>

    Solid

    import { Component, createEffect, createSignal } from 'solid-js';
    import MessageComponent from './components/MessageComponent';
    
    const App: Component = () => {
      const LS: string = 'jsFrameworkComparison-solid-messages';
      const [list, setList] = createSignal<Message[]>([]);
      setList(JSON.parse(window.localStorage.getItem(LS) ?? '[]') as Message[]);
    
      const sendMessage = (event: any) => {
        setList([...list(), { message: event.target.value, date: new Date() }]);
        window.localStorage.setItem(LS, JSON.stringify(list()));
      }
    
      const emptyList = () => {
        setList([]);
        window.localStorage.setItem(LS, '[]');
      }
    
      return (
          <div class={styles.content}>
            <input type="text" onchange={(event) => sendMessage(event)} />
            {list().map(elem => <MessageComponent message={elem} />)}
            <button onclick={() => emptyList()}>Empty</button>
          </div>
      );
    };
    
    export type Message = {
      message: string;
      date: Date;
    }
    
    export default App;

    React / Preact

    import { useEffect, useState } from 'react';
    import MessageComponent from './components/MessageComponent';
    
    const LS: string = 'jsFrameworkComparison-react-messages';
    
    function App() {
      const [list, setList] = useState<Message[]>([]);
    
      useEffect(() => {
        setList(JSON.parse(window.localStorage.getItem(LS) ?? '[]') as Message[]);
      }, []);
    
      const sendMessage = (event: any) => {
        setList([...list, { message: event.target.value, date: new Date() }]);
        window.localStorage.setItem(LS, JSON.stringify(list));
      }
    
      const emptyList = () => {
        setList([]);
        window.localStorage.setItem(LS, '[]');
      }
    
      return (
        <div className="content">
            <input type="text" onBlur={(event) => sendMessage(event)} onKeyDown={(event) => event.key === 'Enter' ? sendMessage(event) : {}} />
          {list.map((elem, i) => <MessageComponent key={i} message={elem} />)}
          <button onClick={() => emptyList()}>Empty</button>
        </div>
      );
    };
    
    export type Message = {
      message: string;
      date: Date;
    }
    
    export default App;

    Qwik

    import { component$, useSignal, useBrowserVisibleTask$, $, useStore } from '@builder.io/qwik';
    import MessageComponent from './components/MessageComponent';
    
    const title: string = 'Qwik app';
    const LS: string = 'jsFrameworkComparison-qwik-messages';
    
    export default component$(() => {
      const list = useStore<{ value: Message[] }>({ value: [] });
    
      const sendMessage = $((event: any) => {
        list.value = [...list.value, {message: event.target.value, date: new Date()}];
        window.localStorage.setItem(LS, JSON.stringify(list.value));
      });
    
      const emptyList = $(() => {
        list.value = [];
        window.localStorage.setItem(LS, '[]');
      });
    
      useBrowserVisibleTask$(() => {
        list.value = JSON.parse(window.localStorage.getItem(LS) ?? '[]') as Message[];
      });
    
      return (
        <div class="content">
          <input type="text" onChange$={(event) => sendMessage(event)} />
          <span>{list.value.length}</span>
          {list.value.map((elem, i) => (<MessageComponent key={i} message={elem} />))}
          <button onClick$={() => emptyList()}>Empty</button>
        </div>
      );
    });
    
    export type Message = {
      message: string;
      date: Date;
    }

    Vanilla JS

    <input type="text" onchange="sendMessage(event)" />
    <div id="MessageComponent"></div>
    <button onclick="emptyList()">Empty</button>
    MessageComponent = document.getElementById('MessageComponent');
    const LS = "jsFrameworkComparison-vanilla-messages";
    document.getElementById('title').innerHTML = title;
    
    let list = [];
    
    list = JSON.parse(window.localStorage.getItem(LS) ?? "[]");
    
    list.forEach(m => renderMessage(m));
    
    function sendMessage(event) {
        const message = { message: event.target.value, date: new Date() };
        list.push(message);
        renderMessage(message);
        window.localStorage.setItem(LS, JSON.stringify(list));
    }
    
    function renderMessage(message) {
        MessageComponent.innerHTML += `<div class="elem">
        <span class="message">${message.message}</span>
        <span class="date">${message.date.toString()}</span>
      </div>`;
    }
    
    function emptyList() {
        list = [];
        MessageComponent.innerHTML = '';
        window.localStorage.setItem(LS, "[]");
    }
    Visit original content creator repository
  • SciBlend-Core

    SciBlend: Bridging Paraview and Blender for Scientific Visualization v.2.0.0

    SciBlend is a powerful add-on for Blender 4.2 that serves as a crucial bridge between Paraview and Blender, revolutionizing the way scientific simulations are visualized. By combining Paraview’s advanced data processing capabilities with Blender’s superior rendering engine, SciBlend enables researchers and scientists to create stunning, photorealistic visualizations of complex scientific data in real-time.

    Table of Contents

    1. Why SciBlend?
    2. Features
    3. Requirements
    4. Installation
    5. Exporting Data from Paraview
    6. Usage in Blender
    7. Contributing
    8. Support
    9. Demos

    Demo.mp4


    Updated Features

    • Advanced X3D Import: Import static and animated X3D data with customizable settings.
    • Material Management: Easily create and apply shared materials to represent different data attributes.
    • Null Object Manipulation: Create and manipulate null objects for better scene organization and data representation.
    • Object Grouping: Efficiently group objects by type for improved scene management.
    • Quick Scene Setup: Set up scenes with predefined lighting and render settings optimized for scientific visualization.
    • Dynamic Boolean Operations: Perform boolean operations to create cutaways and cross-sections of your data.
    • User-Friendly Interface: Access all functions through a streamlined UI panel designed for scientists and researchers.

    Major Changes from Previous Version

    • Code Reorganization: The code has been reorganized into separate modules for better maintainability and scalability.

    Why SciBlend?

    Scientific simulations often produce complex, multi-dimensional data that can be challenging to visualize effectively. While Paraview excels at processing and analyzing this data, it may fall short in creating visually appealing, publication-quality renders. On the other hand, Blender offers unparalleled rendering capabilities but lacks specialized tools for handling scientific datasets.

    SciBlend bridges this gap, allowing scientists to:

    1. Seamlessly import Paraview data: Bring your simulation data directly into Blender without losing fidelity.
    2. Create real-time visualizations: Leverage Blender’s real-time rendering capabilities for interactive data exploration.
    3. Produce photorealistic renders: Utilize Blender’s advanced rendering engines to create stunning, publication-ready visualizations.
    4. Enhance scientific communication: Make complex data more accessible and engaging through high-quality visual representations.

    Features

    • Advanced Paraview Import: Import static and animated data from Paraview with customizable settings.
    • Material Management: Easily manage and apply materials to represent different data attributes.
    • Null Object Manipulation: Create and manipulate null objects for better scene organization and data representation.
    • Object Grouping: Efficiently group objects by type for improved scene management.
    • Quick Scene Setup: Set up scenes with predefined lighting and render settings optimized for scientific visualization.
    • Dynamic Boolean Operations: Perform boolean operations to create cutaways and cross-sections of your data.
    • User-Friendly Interface: Access all functions through a streamlined UI panel designed for scientists and researchers.

    Requirements

    • Blender 4.2 or higher
    • Paraview 5.13 or higher (for initial data processing)
    • Python 3.11 (bundled with Blender 4.2)

    Installation

    SciBlend consists of two main components: Paraview Macros for data export and a Blender Addon for data import and visualization. Follow these steps to install both components.

    1. Paraview Macros Installation

    1. Locate the export_static.py and export_animation.py files in the Paraview Macros directory of the SciBlend folder.
    2. Open Paraview.
    3. Go to Macros > Import New Macro.
    4. Select the export_static.py file and click “OK”.
    5. Repeat steps 3-4 for export_animation.py.
    6. The macros will now appear in the Macros menu of Paraview.

    2. Blender Addon Installation

    1. Locate the SciBlend folder containing all the Blender addon files.
    2. Create a zip file of the entire SciBlend folder. On most systems, you can right-click the folder and select “Compress” or “Create archive”.
    3. Open Blender and go to Edit > Preferences > Add-ons.
    4. Click on Install... and select the SciBlend zip file you created.
    5. Enable the addon by checking the box next to SciBlend.

    Exporting Data from Paraview

    Now that you have installed the Paraview Macros, you can use them to export your data:

    Using Paraview Macros

    Static Export

    1. Open your data in Paraview and set up the view as desired.
    2. Select the object you want to export in the Pipeline Browser.
    3. Go to Macros > Export Static.
    4. A dialog will appear asking for the export directory. Enter the full path and click “OK”.
    5. The macro will export the selected object in the specified directory.

    Animation Export

    1. Open your animated data in Paraview and set up the view as desired.
    2. Select the object you want to export in the Pipeline Browser.
    3. Go to Macros > Export Animation.
    4. A dialog will appear asking for the export directory. Enter the full path and click “OK”.
    5. Another dialog will ask for the number of frames to export. Enter the desired number and click “OK”.
    6. The macro will export each frame of your animation in the specified directory.

    Note: These macros use a simple GUI to ask for the export directory and, in the case of animations, the number of frames. You can select multiple objects in case that you need more than one from the Pipeline Browser.

    Usage in Blender

    Once the Addon is installed, SciBlend adds a new panel to the 3D Viewport sidebar. Here’s a brief overview of the main functions:

    1. Importing Paraview Data

    Static Import

    • Use the “Import Static” option for single-frame data.
    • Customize import settings such as axis orientation and scale factor to match your Paraview export.

    Animated Import

    • Use “Import Animation” for time-series data.
    • Specify the range of frames to import using two sliders:
      • Start Frame Number: Set the first frame of your animation sequence.
      • End Frame Number: Set the last frame of your animation sequence.
    • Adjust the orientation of the imported data:
      • Forward Axis: Choose which axis (X, Y, Z, -X, -Y, -Z) should be considered as “forward” in Blender.
      • Up Axis: Choose which axis should be considered as “up” in Blender.
    • Set a scale factor to resize your imported data as needed.

    2. Data Visualization

    • Apply and manage materials to represent different data attributes.
    • Use null objects and grouping to organize complex datasets.
    • Perform boolean operations to create cutaways and cross-sections.

    3. Scene Setup

    • Quickly set up a scene with lighting and render settings optimized for scientific visualization.

    4. Real-time Interaction

    • Utilize Blender’s real-time rendering capabilities to interactively explore your data.

    5. Final Rendering

    • Leverage Blender’s advanced rendering engines to create publication-quality images and animations of your scientific data.

    Contributing

    Contributions are welcome! Feel free to open issues or submit pull requests to improve this project.

    Support

    For questions, issues, or feature requests, please use the GitHub issue tracker or contact the maintainer at marinfarinajose@gmail.com.

    Demos


    Point.Cloud.Visualization.mp4



    Glyphs.Visualization.mp4



    Rendered.results.using.Blender.Cycles.mp4


    Visit original content creator repository

  • pgn-tactics-generator

    pgn-tactics-generator

    About

    This is a python application dedicated to creating chess puzzles/tactics from a pgn file.
    Also it can download your games from lichess.org and use that file.

    It’s based on the great https://github.com/clarkerubber/Python-Puzzle-Creator by @clarkerubber

    Things that I changed:

    • Use a local pgn file with games as a source.
    • Write results to a file called tactics.pgn
    • Default engine depth to 8, so it’s faster. Before it was nodes=3500000 this is a depth around 20. So it took several minutes to analyze a game. With depth 8 it takes seconds.
    • You can use the depth argument to change the depth if you want more precision.
    • chess.pop_count to chess.popcount, because it was failing

    This is too complex, give something easy.

    There is another option if you don’t want to install and manage python scripts
    I created a more user friendly tactics generator and it’s online http://chesstacticsgenerator.vitomd.com
    It uses a different approach to create tactics, so probably it will generate a different set of tactics.

    Installation

    This script requires the Requests and Python-Chess libraries to run, as well as a copy of Stockfish
    Is recommended that you use Python 3 and pip3. But it could work with Python 2.7 and pip (probably you will need to install futures pip install futures )

    Please, take a look at development doc for details.

    Install requirements

    pip3 install -r requirements.txt --user

    Setup

    MacOS / Linux : sh build-stockfish.sh to obtain the current lichess Stockfish instance.

    Launching Application

    Downloading games for a specific user

    You can download games from a specific user using this command:
    python3 download_games.py <lichess username>

    By default, it will download the last 60 games from blitz, rapid and classical.

    Arguments

    You can use the max argument to get more games and use the lichess api token with the token argument to make the download faster. https://lichess.org/api#operation/apiGamesUser

    It will save the games in the games.pgn file

    Example to get 100 games using the token

    python3 download_games.py <lichess username> --max 100 --token 123456789

    Downloading games from tournaments

    You can download games from multiple tournaments using this command:

    python3 download_tournaments.py E14kHVwX tdntXNhy

    The arguments are the tournaments ids separate by a space

    It will save the games in the games.pgn file

    Generate tactics

    To execute the generator execute this command. By default it will look for the games.pgn file:

    python3 main.py

    Arguments

    • --quiet to reduce the screen output.
    • --depth=8 select the Stockfish depth analysis. Default is 8 and will take some seconds to analyze a game, with --depth=18 will take around 6 minutes.
    • --games=ruy_lopez.pgn to select a specific pgn file. Default is games.pgn
    • --strict=False Use False to generate more tactics but a little more ambiguous. Default is True
    • --threads=4 Stockfish argument, number of engine threads, default 4
    • --memory=2048 Stockfish argument, memory in MB to use for engine hashtables, default 2048
    • --includeBlunder=False If False then generated puzzles won’t include initial blunder move, default is True
    • --stockfish=./stockfish-x86_64-bmi2 Path to Stockfish binary.
      Optional. If omitted, the program will try to locate Stockfish in current directory or download it from the net

    Example:
    python3 main.py --quiet --depth=12 --games=ruy_lopez.pgn --strict=True --threads=2 --memory=1024

    Tactics output

    The resulting file will be a pgn file called tactics.pgn. Each tactic contains the headers from the source game.
    The result header is the tactic result and not the game result. It can be loaded to a Lichess study or to an app like iChess to practice tactics.

    Problems?

    Stockfish errors

    Want to see all my chess related projects?

    Check My projects for a full detailed list.

    Visit original content creator repository

  • falcon-base-services

    Falcon Base Services

    Many WordPress developers long for features like Eloquent, Blade, Service Container, and Service Provider to help them build powerful plugins. Falcon is here to change the game and bring these capabilities to your fingertips.

    Please note: This plugin provides a series of services and is not intended to be used as a base for creating new plugins.

    Features

    • Powerful Service Container and Service Provider
    • Query Builder
    • Eloquent
    • Template Engine (Blade, Twig)
    • Logger (Monolog)
    • Email (PHPMailer)
    • Laravel Validation
    • Request Handling
    • Scheduler
    • Environment Management
    • Symfony Var-Dumper (dd, dump)
    • Carbon
    • Additional Helpers to develop your plugin fast.

    Minimum PHP version: 8.2

    Installation

    1. Create Directory: In the wp-content folder, if the mu-plugins folder does not exist, create it. Place the falcon-base-services folder inside it.

    2. Create Loader File: In the root of the mu-plugins folder, create a PHP file with a name of your choice and add the following code:

      <?php
      require 'falcon-base-services/falcon-base-services.php';

      Note that the contents of the mu-plugins folder do not need to be activated in the WordPress admin and are executed before all other plugins. Also, WordPress does not scan the folders inside mu-plugins unless explicitly instructed.

    3. Install Dependencies: Open the terminal in the falcon-base-services folder and run the following command:

      composer install

      If you haven’t installed Composer, you can download and install it from this link.

    The plugin is now ready to use. Letโ€™s explore its features and how to use them.

    Maintenance Mode

    If you need to put the site in maintenance mode, simply rename the maintenance.example.php file in the storage folder to maintenance.php. You can also edit the contents of the file as needed.

    Environment Variables (ENV)

    Items mentioned in the .env.example file are important. Rename the file to .env.

    get

    You can set your variables in the .env file and use them anywhere in your code like this:

    $_ENV['item'];
    //or
    env('item')

    set

    To set an item in the global $_ENV var, you can use:

    setEnv($key, $value);

    Config

    You can also use configuration files in your project that return an array.
    Place the configuration file in the config folder and access the desired values using the falconConfig($file, $key = null, $folder_path = null) function.

    • $file: The name of the configuration file.

    • $key: The key of the requested array. If null, the entire file content is returned.

    • $folder_path: By default, the path to the configuration files is in the config folder. If you want to have new configurations in your project, you can also specify the path to the new folder.

    Service Container – Service Provider

    The plugin uses a powerful service container with autowiring capabilities.

    • Singleton Services: Register a singleton service using:

      FALCON_CONTAINER->singleton(Test::class);
      // or
      FALCON_CONTAINER->singleton('test', Test::class);
    • Non-Singleton Services: Register a non-singleton service using:

      FALCON_CONTAINER->bind(Test::class);
      // or
      FALCON_CONTAINER->bind('test', Test::class);
    • Using Closures: You can also use closures:

      FALCON_CONTAINER->bind('test', function() { return Test::class; });
    • Using the Services: Use the get method to retrieve the services:

      FALCON_CONTAINER->get('test');
      FALCON_CONTAINER->get(Test::class);
    • Resolving Methods: Resolve a method from a class using:

      FALCON_CONTAINER->getMethod(Test::class, 'run');

      This will automatically resolve any dependencies required by both the class and the method.

    To create a service provider, create a class in the app/providers folder and extend the ServiceProvider class. Use the register and boot methods as needed. Then, add the providerโ€™s address in the providers.php file located in the bootstrap folder.

    Eloquent, QueryBuilder

    All default WordPress tables are available as models in the app/Model folder. WooCommerce tables will be added soon. You can use both the powerful Query Builder and Eloquent to interact with these tables.

    • Eloquent:
    (new \FalconBaseServices\Model\Post())->published()->with('author')->get();
    • Query Builder:

    falconDB()::table('wp_posts')
        ->where('post_status', 'publish')
        ->leftJoin('wp_users', 'wp_posts.post_author', '=', 'wp_users.ID')
        ->select('wp_posts.*', 'wp_users.user_nicename')
        ->get();

    If you want to use a new table as a model, create its class by extending the FalconBaseServices\Model\BaseModel class. If the table does not use the default prefix, set $with_prefix to false:

    protected $with_prefix = false;

    The rules and usage of models and Query Builder/Eloquent are exactly like the Laravel documentation.

    Template

    By default, Blade is used as the template engine, which is slightly different in usage from the standard. Pay attention to the example:

    falconTemplate()->setViewDir('path to dir')->setView('name of file without extension')
    ->share(['item' => 'value'])->render();

    You can also use Twig. The class derived from the interface app/Services/TemplateEngine/Template.php is available in the path app/Services/TemplateEngine/Implements/Twig.php. Simply add Twig to the plugin via Composer and then edit the file app/Providers/TemplateServiceProvider.php.
    The usage is similar to the above example.

    Logger

    To use the logger, use falconLogger():

    falconLogger()->error('message', ['data' => 'value']);

    If you want the ProcessIdProcessor, GitProcessor, and MemoryUsageProcessor to be included in the log, set related items in .env file to true.

    Email

    To use email, you can use falconEmail():

    falconEmail()->send($to, $subject, $content, $from = null, $bcc = null);

    For more information on how to use email, refer to the file app/Services/Sender/Implements/Email/PHPMailer.php.

    Happy coding! ๐Ÿš€

    Visit original content creator repository

  • NoteWizard

    Note Wizard Banner

    NoteWizard

    Welcome to NoteWizard! This web application is designed to help students stay organized and informed by providing features such as college notes, syllabus tracking, timetables, and important event notifications.

    Table of Contents

    Introduction
    Technologies Used
    Features
    Getting Started
    Usage
    Contributing
    Contact
    Introduction

    NoteWizard is a powerful tool for students to manage their academic life efficiently. It offers a range of features that assist in organizing and accessing important information such as class notes, syllabi, timetables, and event notifications. This web application aims to enhance productivity and provide a centralized platform for students to stay on top of their studies.

    Technologies Used

    The following technologies were used to develop NoteWizard:

    HTML5
    CSS3
    JavaScript
    Features

    NoteWizard offers the following features:

    College Notes: A section where students can upload and access their class notes, organized by subject or course.
    Syllabus Tracking: Students can input their course syllabi, track important deadlines, and receive reminders for assignments, exams, and projects.
    Timetable: A customizable timetable that allows students to schedule their classes, study sessions, and extracurricular activities.
    Event Notifications: Important event notifications, such as registration deadlines, seminars, or guest lectures, can be displayed to keep students informed.
    Feel free to customize and expand upon these features based on your specific requirements.

    Getting Started

    To set up NoteWizard locally, follow these steps:

    Clone the repository or download the source code.
    Open the project folder in your preferred code editor.
    Modify the HTML, CSS, and JavaScript files to customize the application’s content, styling, and functionality.
    Save your changes.
    Open the index.html file in your web browser to view the application locally.
    Usage

    Customize NoteWizard to meet the needs of your users. You can enhance existing features, add new functionality, or modify the design and layout. Ensure that the application remains user-friendly and intuitive for students to navigate and utilize effectively.

    Contributing

    We appreciate your interest in contributing to NoteWizard! If you have any bug reports, suggestions, or enhancements, please feel free to open an issue or submit a pull request. Your contributions will be invaluable in improving the application for the benefit of all users.

    Contact

    If you have any questions, feedback, or need support, please feel free to contact us via email or any other preferred method.

    Arjun Singh
    arjunsingh15102003@gmail.com
    https://www.linkedin.com/in/arjun-singh-62b7761b6

    Visit original content creator repository

  • crowdfunding

    Frontend Mentor – Crowdfunding product page

    Design preview for the Crowdfunding product page coding challenge

    Welcome! ๐Ÿ‘‹

    Thanks for checking out this front-end coding challenge.

    Frontend Mentor challenges help you improve your coding skills by building realistic projects.

    To do this challenge, you need a basic understanding of HTML, CSS and JavaScript.

    The challenge

    Your challenge is to build out this crowdfunding product page and get it looking as close to the design as possible.

    You can use any tools you like to help you complete the challenge. So if you’ve got something you’d like to practice, feel free to give it a go.

    Your users should be able to:

    • View the optimal layout depending on their device’s screen size
    • See hover states for interactive elements
    • Make a selection of which pledge to make
    • See an updated progress bar and total money raised based on their pledge total after confirming a pledge
    • See the number of total backers increment by one after confirming a pledge
    • Toggle whether or not the product is bookmarked

    Want some support on the challenge? Join our Slack community and ask questions in the #help channel.

    Where to find everything

    Your task is to build out the project to the designs inside the /design folder. You will find both a mobile and a desktop version of the design.

    The designs are in JPG static format. Using JPGs will mean that you’ll need to use your best judgment for styles such as font-size, padding and margin.

    If you would like the design files (we provide Sketch & Figma versions) to inspect the design in more detail, you can subscribe as a PRO member.

    You will find all the required assets in the /images folder. The assets are already optimized.

    There is also a style-guide.md file containing the information you’ll need, such as color palette and fonts.

    Building your project

    Feel free to use any workflow that you feel comfortable with. Below is a suggested process, but do not feel like you need to follow these steps:

    1. Initialize your project as a public repository on GitHub. Creating a repo will make it easier to share your code with the community if you need help. If you’re not sure how to do this, have a read-through of this Try Git resource.
    2. Configure your repository to publish your code to a web address. This will also be useful if you need some help during a challenge as you can share the URL for your project with your repo URL. There are a number of ways to do this, and we provide some recommendations below.
    3. Look through the designs to start planning out how you’ll tackle the project. This step is crucial to help you think ahead for CSS classes to create reusable styles.
    4. Before adding any styles, structure your content with HTML. Writing your HTML first can help focus your attention on creating well-structured content.
    5. Write out the base styles for your project, including general content styles, such as font-family and font-size.
    6. Start adding styles to the top of the page and work down. Only move on to the next section once you’re happy you’ve completed the area you’re working on.

    Deploying your project

    As mentioned above, there are many ways to host your project for free. Our recommend hosts are:

    You can host your site using one of these solutions or any of our other trusted providers. Read more about our recommended and trusted hosts.

    Create a custom README.md

    We strongly recommend overwriting this README.md with a custom one. We’ve provided a template inside the README-template.md file in this starter code.

    The template provides a guide for what to add. A custom README will help you explain your project and reflect on your learnings. Please feel free to edit our template as much as you like.

    Once you’ve added your information to the template, delete this file and rename the README-template.md file to README.md. That will make it show up as your repository’s README file.

    Submitting your solution

    Submit your solution on the platform for the rest of the community to see. Follow our “Complete guide to submitting solutions” for tips on how to do this.

    Remember, if you’re looking for feedback on your solution, be sure to ask questions when submitting it. The more specific and detailed you are with your questions, the higher the chance you’ll get valuable feedback from the community.

    Sharing your solution

    There are multiple places you can share your solution:

    1. Share your solution page in the #finished-projects channel of the Slack community.
    2. Tweet @frontendmentor and mention @frontendmentor, including the repo and live URLs in the tweet. We’d love to take a look at what you’ve built and help share it around.
    3. Share your solution on other social channels like LinkedIn.
    4. Blog about your experience building your project. Writing about your workflow, technical choices, and talking through your code is a brilliant way to reinforce what you’ve learned. Great platforms to write on are dev.to, Hashnode, and CodeNewbie.

    We provide templates to help you share your solution once you’ve submitted it on the platform. Please do edit them and include specific questions when you’re looking for feedback.

    The more specific you are with your questions the more likely it is that another member of the community will give you feedback.

    Got feedback for us?

    We love receiving feedback! We’re always looking to improve our challenges and our platform. So if you have anything you’d like to mention, please email hi[at]frontendmentor[dot]io.

    This challenge is completely free. Please share it with anyone who will find it useful for practice.

    Have fun building! ๐Ÿš€

    Visit original content creator repository