forked from twitter/opensource-website
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:hasadna/hasadna.github.io
- Loading branch information
Showing
1 changed file
with
21 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,34 @@ | ||
|
||
# Hasadna - eKnight Land | ||
|
||
This project is the public-facing site of the Open Knowledge Workshop. | ||
|
||
The site contains details on any of the open-source project maintained by workshop members that currently require help from | ||
the developers community. | ||
|
||
## Adding new projects | ||
|
||
To add a new Github project to the site, please edit `eKnightsData.js` and add a new JSON entity that includes: | ||
|
||
* **name** - project name | ||
* **permalink** - permalink to project website | ||
* **about** - short descriptive text about the project | ||
* **status** - the project status | ||
* **entry_level** - what's the required expertise to participate in this project | ||
* **issuesUrl** - github API link. | ||
* **slug** - | ||
* **discussion_board** - link to project's discussion board | ||
* **github_repo** - relative name of Github repo (under hasadna namespace) | ||
* **leaders** - Github user names of project leaders | ||
|
||
## Requirements | ||
node js | ||
- node.js | ||
- [Grunt](http:https://gruntjs.com) | ||
- [Bower](http:https://bower.io) | ||
|
||
|
||
## Installing and running locally | ||
|
||
```bash | ||
$ git clone https://github.com/hasadna/hasadna.github.io | ||
$ git clone https://github.com/hasadna/hasadna.github.io | ||
$ cd hasadna/hasadna.github.io | ||
$ bower install | ||
$ grunt | ||
$ python -m SimpleHTTPServer # Or: python3 -m http.server | ||
``` | ||
Point your browser to [http:https://0.0.0.0:8000](http:https://0.0.0.0:8000) | ||
|
||
|
||
### Running the eKnights editor | ||
```bash | ||
$ cd hasadna/hasadna.github.io/editor | ||
$ node server.js | ||
``` | ||
should run from localhost. | ||
Go to [http:https://localhost:8888](http:https://localhost:8888) | ||
|