Giter Site home page Giter Site logo

pertrai1 / rxjs-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from reactivex/rxjs-docs

0.0 3.0 0.0 28.62 MB

The home for new work on the new RxJS docs (RxJS v 5 and up). New to this space? Say hi here: https://github.com/ReactiveX/rxjs-docs/issues/24. Want to find out what's up? We're chatting here. https://github.com/ReactiveX/rxjs-docs/issues/4

License: Apache License 2.0

JavaScript 4.70% TypeScript 86.85% HTML 5.31% CSS 3.13%

rxjs-docs's Introduction

Build Status

The home for new work on the new RxJS docs (RxJS v5 and up). Website (currently beta) can be found here. We highly welcome any kind of feedback or contribution.

License is the same as the RxJS project: https://github.com/reactivex/rxjs

Apache 2.0 License

Important

By contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the Contributor Code of Conduct. Much like traffic laws, ignorance doesn't grant you immunity.

Goals

  • Serve updated docs for RxJs
  • Serve multiple translations for the docs
  • Provide working examples

Contributing

More detailed information can be found in the Contribution Guidelines

Building/Testing

The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:

  • start: runs the dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
  • test: runs tests with jasmine, must have built prior to running.
  • build: build artifacts will be stored in the dist/ directory
  • build-prod: builds for production using the --prod flag
  • commit: runs git commit wizard for passing rxjs-github-bot message validator

Committing

It is strongly recommended that when creating a commit, you follow this procedure to start the commit wizard. It will aid you on creating valid commit messages.

git add .
npm run commit

rxjs-docs's People

Contributors

ashwin-sureshkumar avatar btroncone avatar feloy avatar jotatoledo avatar sumitarora avatar ladyleet avatar kwonoj avatar only1mranderson avatar fredrik-lundin avatar chrisdemars avatar hardikpthv avatar natmegs avatar niklas-wortmann avatar diedrikdm avatar mustafamg avatar benlesh avatar iraershova avatar grumblerchester avatar cschomer avatar zualexander avatar angular-cli avatar brandonroberts avatar luillyfe avatar jefiozie avatar nicolaisueper avatar necoline avatar saiprasad2595 avatar

Watchers

Rob Simpson avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.