{"id":18496324,"url":"https://github.com/oddbird/knet","last_synced_at":"2025-05-14T04:31:27.813Z","repository":{"id":8092948,"uuid":"9507222","full_name":"oddbird/knet","owner":"oddbird","description":"Collecting stories of inspiration for teachers","archived":false,"fork":false,"pushed_at":"2013-07-27T20:43:06.000Z","size":67079,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-09T17:25:03.436Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.theknetwork.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oddbird.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-17T20:46:55.000Z","updated_at":"2018-11-27T16:55:14.000Z","dependencies_parsed_at":"2022-09-09T10:10:19.465Z","dependency_job_id":null,"html_url":"https://github.com/oddbird/knet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fknet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fknet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fknet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fknet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oddbird","download_url":"https://codeload.github.com/oddbird/knet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254060818,"owners_count":22007908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T13:28:58.498Z","updated_at":"2025-05-14T04:31:27.795Z","avatar_url":"https://github.com/oddbird.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"K Network\n=========\n\nDevelopment\n-----------\n\nIf you want to run this project in a `virtualenv`_ to isolate it from other\nPython projects on your system, create a Python 3.3 virtualenv and activate it.\nThen run ``bin/install-reqs`` to install the dependencies for this project into\nyour Python environment (you should re-run this whenever any file in the\n``requirements/`` directory changes).\n\nIn order to run K Network (or its tests), you'll need a PostgreSQL database. By\ndefault, K Network will look for a PostgreSQL database named \"knet\" on\nlocalhost. To use a different database, set the ``DATABASE_URL`` environment\nvariable to a Postgres database URL; e.g. ``postgres://user@host/dbname``.\n\nOnce this configuration is done, you should be able to run ``./manage.py syncdb\n--migrate``, then ``./manage.py runserver`` and access the site in your browser\nat ``http://localhost:8000``.\n\nLocal development on this project requires `Node.js`_ \u003e= 0.8.0 for JS linting\nand tests. To install the necessary Node dependencies, first ``npm install -g\ngrunt-cli`` (once per system), then ``npm install`` (whenever ``package.json``\nchanges).\n\nYou can run the Python tests with ``py.test`` (or ``grunt pytest``), or the\n``Selenium`` tests with ``py.test knet/tests/selenium`` (or ``grunt\nselenium``).\n\nYou can lint the project's JS with ``grunt jshint`` and run the JS unit tests\nwith ``grunt qunit``.\n\nYou can compile Handlebars templates in the ``jstemplates/`` directory to the\ncompiled-templates file (``static/js/jstemplates.js``) with ``grunt handlebars``.\n\nJust running ``grunt`` will perform all of the above tasks except the Selenium\ntests.\n\n``grunt dev`` will watch for changes to local files and automatically perform\nan appropriate selection of the following tasks whenever changes are detected\nto files in the ``static/js/``, ``jstests/``, ``jstemplates/``, ``templates/``\nand ``knet/`` directories:\n\n* compile Handlebars templates\n* validate JS with `JSHint`_\n* run the JS unit tests\n* run the Python tests\n\nRefer to the Gruntfile.js source and `Grunt`_ documentation for more info.\n\nTo install the necessary Ruby gems for Compass/Sass development (only\nnecessary if you plan to modify Sass files and re-generate CSS), install\nBundler (``gem install bundler``) and then run ``bundle install``.\n\n.. _virtualenv: http://www.virtualenv.org\n.. _Node.js: http://nodejs.org\n.. _JSHint: http://www.jshint.com\n.. _Grunt: http://gruntjs.com/\n\nDeployment\n----------\n\nIn addition to the above configuration, in any production deployment\nthis entire app should be served exclusively over HTTPS (since serving\nauthenticated pages over HTTP invites session hijacking\nattacks). Ideally, the non-HTTP URLs should redirect to the HTTPS\nversion.\n\nTo turn on settings appropriate for a production deployment, set the\nenvironment variable ``KNET_MODE=prod``.\n\nYou can run ``./manage.py checksecure`` to verify that settings are correctly\nconfigured for a secure deployment.\n\nThis app also uses the `staticfiles contrib app`_ in Django for collecting\nstatic assets from reusable components into a single directory for production\nserving.  Under \"runserver\" in development this is handled automatically.  In\nproduction, run ``./manage.py collectstatic`` to collect all static assets\nusing the storage engine configured by the ``KNET_STATICFILES_STORAGE`` env\nvar, and make those collected assets available by HTTP at ``KNET_STATIC_URL``.\n\n.. _staticfiles contrib app: http://docs.djangoproject.com/en/1.5/howto/static-files/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddbird%2Fknet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foddbird%2Fknet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddbird%2Fknet/lists"}