|
1 | | -# wilyer-wcs-learning |
| 1 | +## Open Learning Resources by Wilyer Engineering |
2 | 2 |
|
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +### How to contribute to this project? |
| 8 | +#### Install NodeJS and Git |
| 9 | + |
| 10 | +#### <a name="development"></a> Development |
| 11 | + |
| 12 | +To get started with WilyerEngineering/learn **development**, you need to install [NodeJS](https://nodejs.org/en/) and [Git](https://git-scm.com/). |
| 13 | + |
| 14 | + |
| 15 | +- After Installation Make Sure following 3 Commands work as shown in the given image. |
| 16 | + |
| 17 | +```bash |
| 18 | +$ node --version |
| 19 | +``` |
| 20 | +npm will install automatically when you install NodeJS |
| 21 | +```bash |
| 22 | +$ npm --version |
| 23 | +``` |
| 24 | +```bash |
| 25 | +$ git --version |
| 26 | +``` |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | + Then install `hexo-cli` globally: |
| 34 | + |
| 35 | +```bash |
| 36 | +$ npm install hexo-cli -g |
| 37 | +``` |
| 38 | + |
| 39 | +Get the theme source and install the dependencies: |
| 40 | + |
| 41 | +```bash |
| 42 | +$ git clone https://github.com/WilyerEngineering/learn.git |
| 43 | + |
| 44 | +$ cd learn && npm install |
| 45 | +``` |
| 46 | + |
| 47 | + |
| 48 | +If you want to update the visual aspects of your front-end, we suggest using our [user documentation](https://zalando-incubator.github.io/hexo-theme-doc) site as a playground for previewing your changes. First, [link](https://docs.npmjs.com/cli/link) the theme package globally with: |
| 49 | + |
| 50 | +```bash |
| 51 | +$ cd learn && npm link |
| 52 | +``` |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +Now [link](https://docs.npmjs.com/cli/link) the theme package as a dependency (this will use your local version): |
| 58 | + |
| 59 | +```bash |
| 60 | +$ npm link learn |
| 61 | +``` |
| 62 | + |
| 63 | +Finally run the built-in server: |
| 64 | + |
| 65 | +```bash |
| 66 | +$ hexo s |
| 67 | +``` |
| 68 | + |
| 69 | +Open your browser at http://localhost:4000, and hopefully you'll see the documentation site up and running. |
| 70 | + |
| 71 | + |
| 72 | +**Great Now http://localhost:4000/learn will be live on your local system.** |
| 73 | + |
| 74 | +## Understand Development Pipline |
| 75 | +There is a branch named `master` which is automatically created and updated as per the commits made into branch named `source`. |
| 76 | + |
| 77 | +There is a branch named `dev` which is for development and updates so if you do some changes to the code make sure you make a pull request in dev branch so that your updates can be tested by the core team and merged to `source` branch after testing. |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +#### Wilyer Engineering's Open Sourced Learning Website is made possible by Hexo and hexo-theme-doc details of which can be found below. |
| 84 | +#### Meta Data About the Template and Design |
3 | 85 | This project is a skeleton for a documentation website using [Hexo](https://hexo.io) and [hexo-theme-doc](https://github.com/zalando-incubator/hexo-theme-doc). |
4 | 86 | You can use it to quickly bootstrap your documentation website. |
5 | 87 |
|
|
0 commit comments