-
Notifications
You must be signed in to change notification settings - Fork 1
Contributing
Edric Chan edited this page Dec 22, 2017
·
1 revision
To begin contributing to the web app, follow either one of these methods:
Apply at the Send Feedback
Google form, available under the sidenav.
It's at the last section of the whole form.
NOTE: The following code snippets are for macOS.
- Click on the fork button at the app's repo to make a copy of the repo.
- In your terminal, type the following code:
cd ~/Desktop # Or whatever place you would like the clone project to be placed at
git clone https://github.com/<your-username>/rss-reader.git
- It should clone the project locally onto your desktop. In your terminal (once again), type the following code:
cd rss-reader
npm install # Installs all the dependencies
gulp docs # To create documentation
ng serve
- Changes you make will be saved live.
- After you're done making changes to a file(s), add the files to
git
, add a commit message andpush
it. (If you don't understand what I meant... Well, good luck.)- For those who use Github Desktop, you should know how to do these simple stuff. Or else you're really screwed or you're a new user. Anyways, here's a guide on How-To Github Desktop.
Done!
Licensed with MIT
:
MIT License
Copyright (c) 2017-18 Edric Chan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the Software), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
- Code originally from becompany/angular2-rss-reader-tutorial, more functionality added to fork of original repo.