Skip to content

Latest commit

 

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Czym jest Webstream?

Nasz -> Twój zespół

Inne projekty do których możesz dołączyć i współtworzyć

Jak wesprzeć projekt?

Jakie mamy plany?

Github

share your username

https://github.com/web-stream/task/settings/access?guidance_task=

  • po dodaniu i nadaniu praw do pracy z projektem zapoznaj się z listą zadań

Start work with project repository on Github

get the task from the list

Prepare a github project

there are two ways, with branch per ticket or without direclty to master.

If there are working many people on some repository we need use Merge Request

fork the source of webstream:

github.com/web-stream/src

fork a examples:

github.com/web-stream/examples

create your own repo on your username:

webstream-examples

Environment

prepare environment:

node js

testing

start to use the project

coding

start to change the source code to find the bugs or implement the features

unittesting

every time you changed the code or you produced somthing new, check the unittest

get the next task

every time you are starting the next task, please create the new folder as task number

[webstream main project folder]/[task number]/[webstream sourcode]

put to the file:

github.txt 

the branch url in content

load the sourcode over apicup commmands:

sh github clone

check if work

sh test

create sourceode changes and

sh test

if everything is OK, push on server

sh push

After you finish , please make a MR

sh github mr

DevOps

First Steps with .apicra

on linux

install

sh .apicra/install

install promagen

sh .apicra/promagen

start

sh .apicra/start

open in browser

sh .apicra/browser

on windows

install

.apicra\install.bat

start

.apicra\start.bat

open in browser

.apicra\browser.bat

codereview

After you finish I will check your code If everything will be correct I will merge

if not I will write you some info

Kod źródłowy

Biblioteki/Funkcje podstawowe:

https://github.com/apifunc/js/tree/master/src

Kod źródłowy Webstream:

https://github.com/web-stream/src

Biblioteki Funkcje zewnętrzne potrzebne do renderowania, np MARKDOWN

https://revealjs.com/installation/#full-setup

kompilowanie pojedynczej funkcji

przygotowanie paczka webstream.min.js

clone https://github.com/web-stream/build

win

build-all.bat

lx (todo)

build-all.sh

File build-all.bat

type ".\src\meta\*.js" > .\jloads.js
type ".\src\core\*.js" >> .\jloads.js
type "..\apifunc-js\src\*.js" >> .\jloads.js
type ".\src\event\*.js" >> .\jloads.js
type ".\src\include\*.js" >> .\jloads.js
type ".\src\load\*.js" >> .\jloads.js
type ".\src\*.js" >> .\jloads.js
type ".\src\form\*.js" >> .\jloads.js
type ".\src\url\*.js" >> .\jloads.js
type ".\src\jloads\*.js" >> .\jloads.js
type ".\src\all\*.js" >> .\jloads.js
uglifyjs jloads.js -o jloads.min.js -c -m

Suggestions

FLOW of creation with webstream

focus on small defined problem in some context and make the context smaller by the iteration

Create just one function

  • Don’t create all in one class.
  • Think about your problem and solve it by many functions, but make it more generic to extend with another functions

*Deliver in small pieces+

  • Do not bury your work on the long-living branch.
  • There is a high risk that you will never finish that.
  • Break it up into smaller pieces and deliver on each piece, one by one.
    • extend the functionality by modularisation

*Take care of the documentation+

  • without documentation, no one will use your code.
  • Make a README one file documentation

*Create a CI / CD flow+

  • Many tools allow you to configure a free CI process for Open Source projects expressly:
    • DevOps, Github Actions, Travis, etc.
  • User should started the code-base without failure.
    • The repository should be builded and tested.
  • This is crucial for potential contributors.

*Join the community+

communication channel Every popular library has its communication channel, be it Slack, Gitter, Discourse or a mailing list.

Join it, check how people communicate with each other and how they help on issues. Verify if this is the place you want to be.

From such a channel, you can also assess whether the community is alive. If there are active discussions, there is a greater chance that the library is maintained.

Help others

Open Source, as the name suggests, is about being OPEN.

Even if you do not consider yourself an expert, your advice may be valuable to someone. Don’t be afraid that someone will tell that: you’re wrong. Even if someone criticizes your work, you will at least learn something new. You will confront your thinking.

About Webstream

About Tom Sapletta

Devops supported by Api Foundation

  • .apicra - bash scripts to prepare environment
  • .apifunc - funkcje, implementacja apiunit
  • .apiunit - metadane potrzebne do stworzenia aplikacji
  • .apibuild - budowanie plaikacji, deployment
  • .apiterminal - devops terminal by web

Substantively supported by:

Sponsored by:


https://github.com/web-stream/start.git

About

How to start? start.webstream.dev

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors