Skip to content

webcodesk/webcodesk-srv

Repository files navigation

Webcodesk Screenshot

Webcodesk is an application that installed as an npm module. It consists of two parts: a server part and a client part. The server part is a NodeJS application that should be started in the command line on the local computer. The client part runs in the web browser.

Webcodesk helps the developer in creating Web applications with React UI components. It has a bunch of visual editors where the user can compose UI components on the pages, create data flow logic between UI components, and debug data flow visually.

Introduction

Read the article on Hackernoon about why Webcodesk was created:

To React developers

Your experience will tell you that you do not need any visual builders because they are limited in functionality, unreliable, and they all suck.

Give Webcodesk a chance and try to create your own small single-page application, I assure you, you won't ever want to write a ton of extra code.

  • You don't have to learn anything new. Rather, you will not write any unnecessary code for Redux.

  • Webcodesk does not generate code. It uses a small framework that is reliable. The proof of reliability is the fact that the framework is used inside Webcodesk itself.

How it works

Each project for Webcodesk is bootstrapped by create-react-app. Additionally, react-app-framework, a library designed for Webcodesk, is added to the project code.

The project contains configuration files that are fed to the React App Framework. The Framework in its turn creates pages, routes, and makes containers for Redux from simple React components.

Then the Framework connects the containers into chains of actions, exactly as you do it using Redux actions.

The configuration of the Framework is complex enough to write it manually. So Webcodesk lets you create and edit it with visual editors:

  • the page editor
  • the flow diagram editor

All you have to do is write the code of React components and functions.

Installation

  • Run commands in the command line one by one.
> npx @webcodesk/install-webcodesk <new-project-name-dir>

> cd ./<new-project-name-dir>

> yarn wcd
  • Open Webcodesk in the browser:
http://localhost:7070
  • Choose any project on the market

  • Now open the project's source code in your favorite IDE

It is better to init a source code repository before you setup the project's workspace in the IDE. For example, please read the instruction about how to do this for GitHub repo: Adding an existing project to GitHub using the command line

Upgrade

  • Go to the project dir and run commands in the command line one by one.
> yarn remove @webcodesk/webcodesk-srv

> yarn add @webcodesk/webcodesk-srv -D -E

Documentation

In the User Guide, you will find technical details on how to create components and functions and how to use them to build an application.

Contribution

I'm quite open to new feature requests, or any work you want to do. But let's discuss the feature in a new issue with the detailed description before creating new PR.

Community

If you need any help or want someone to set up the workspace with you and get you stepping through code in your IDE, don't be afraid to speak up!

License

GNU GPLv3

Copyright (c) 2019 Alex Pustovalov