Vanilla Blog

Vanilla Blog is a personal project aimed to implement basic blog post components leveraging the Vanilla framework, along with custom SASS, TypeScript and plain HTML code. For the sake of cross-browser compatibility, this project implements polyfills and coding strategies to extend support to old legacy browsers, such as MSIE11.

A live running build of this project is available at https://my-vanilla-blog.netlify.app.

Setting up your environment

The minimum requirements for running this project, either on development or production mode, and its development scripts are node v12.16.0 and npm v.6.14.15, or later versions. Probably this project will run smoothly on older versions of node and npm but we recommend using the latest LTS versions.

This project relies on Parcel for spawning dev environments, running builds and handling code optimisations. All interaction with Parcel has been abstracted in custom npm commands for your convenience.

Installing dependencies

As a first step to spawn a development environment or production build, please run either yarn or npm install to pull all the required dependencies for this project.

Configuring the project settings (optional)

Please note: This step is optional and the project is shipped with all settings preconfigured by default. Feel free to skip to the next section if you do not want to customize your data preferences.

The project fetches data from a remote WordPress API endpoint. Particularly, the project will fetch by default 3 items only from the first page of a paginated recordset.

You can update this setup by accessing /src/settings and editing the following parameters:

apiUrl: URL for the remote Wordpress API endpoint installation.
pageSize: Number of items to display.
pageIndex: Current page, as a zero-based integer.

You will want to rebuild the project after updating these settings, although this action will be automatically triggered by Parcel when running the application in development mode.

Firing up a development environment

You can spawn a development environment by running yarn start or npm run start in the console.

The system will generate all the artifacts and assets and the compiled site will be available at http://localhost:8888 in watch mode, so the application will be recompiled upon changes on the source code.

Building the project for production

Please execute yarn build or npm run build in your terminal window.

Parcel will navigate through the entire application tree and build the site into the /dist folder. All files will be conveniently hashed to prevent caching issues.

Code linting and testing

The code in this application is audited with ESLint to ensure code quality, and unit tests built with Jest. The following commands have been made available for your convenience:

yarn lint: lints all TypeScript files, reporting code quality issues if any.
yarn test: runs all the application unit tests.

Code coverage reports

Jest has been configured to generate a full code coverage report in HTML every time the test command is executed. This coverage report can be found at /coverage/lcov-report when running tests in your local environment.

Distributed under the MIT License

Copyright 2020 Pablo Deeleman

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.

License

deeleman/vanilla-blog

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages