Logo Maker

Logo Maker is a react app built with Typescript created for designing simple logos.

Installation on WordPress

The easy way: go to /development and download the zip file, then upload it on the website in wp-admin/plugins.php

The hard way: go to the plugin folder of the WordPress and then git clone https://github.com/Codeinwp/logo-maker.git

To make the back button on the Start page work, you need to assign in WordPress a parent page to the page that host the Logo Maker.

Make sure that the page that hosts the Logo Maker is empty.

Getting starter on development

Don't forget to read the Architecture to see details about the code. For developing in the plugin mod, you need to have a WordPress site installed on the computer or in a container.

Before you venture into the development of the Logo Maker, you need to have:

Node Js with npm & npx - available in the docker container
Git - available in the docker container
Text Editor / IDE (see Recommended Tools)

Developing in containers

With Docker, you can develop the app in standalone and plugin mode. Docker will create two containers: a WordPress server and a database server by running docker-compose up. For working in these containers, you need to have tools that work remotely. Visual Studio Code can give you a seamless experience with the (Docker plugin)[https://code.visualstudio.com/docs/containers/overview] - with one click; you can start developing.

Connecting with terminal

docker exec -it otter-blocks_wordpress_1 bash # enter in the WordPress server and acces the bash shell
cd /var/www/html/wp-content/plugins/logo-maker # go the location of the project

Installation

If you are using the Docker compose file in this project, skip the download part and install the npm packages.

Using npm

git clone https://github.com/Codeinwp/logo-maker.git
cd logo-maker
npm install

Using pnpm (recommended)

git clone https://github.com/Codeinwp/logo-maker.git
cd logo-maker
pnpm install

Using yarn

git clone https://github.com/Codeinwp/logo-maker.git
cd logo-maker
yarn install

Npm Commmands

~~npm run start - start the development server using Snowpack - it's fast and run separately from WordPress - use it for development.~~

npm run start-plugin - start the development server in WordPress using Webpack - the project must be in plugin folder and activated - use it for testing the app as a block in WordPress.

npm run plugin-build - created an optimized version for the app as a WordPress block.

npm run linux:make-zip - this will start the plugin-build and pack it in a zip file in ./development folder - use the zip to install the plugin on stagging site for testing - this will work on a system that supports Linux environment and command - must run ./delopment/linux_setup.sh for installing the zip command.

npm run gen-docs - generate the docs

~~npm run format - format the Typescript file in ./src folder using Prettier~~

~~npm run lint - check for issues in the Typescript file in ./src folder using EsLint~~

Recommended Tools

The coding style is enforced using ESLint with Standard as base rules and adjusted to Typescript.

Prettier is used for formating and is integrated with ESLint (some rules might be disabled in case of conflict).

IDE / Text Editor

Visual Studio Code
- Plugins
  - ESLint
  - Prettier
  - Git Graphs
  - Git Lens
  - Gruvbox Minor
  - Path Intellisense
  - vscode-icons
  - Visual Studio IntelliCode
  - Docker
WebStorm

Shells

fish
zsh
bash

Resources for learning

React

Typescript

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

mars9541/logo-editor