{"id":18496326,"url":"https://github.com/oddbird/portfoliyo","last_synced_at":"2025-04-08T22:32:08.873Z","repository":{"id":4012939,"uuid":"5111816","full_name":"oddbird/portfoliyo","owner":"oddbird","description":"A communication tool for teachers and parents","archived":false,"fork":false,"pushed_at":"2016-02-26T18:18:21.000Z","size":73251,"stargazers_count":11,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T18:48:50.306Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.portfoliyo.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":"2012-07-19T15:30:39.000Z","updated_at":"2024-05-31T18:36:03.000Z","dependencies_parsed_at":"2022-08-26T06:20:53.560Z","dependency_job_id":null,"html_url":"https://github.com/oddbird/portfoliyo","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%2Fportfoliyo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fportfoliyo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fportfoliyo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fportfoliyo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oddbird","download_url":"https://codeload.github.com/oddbird/portfoliyo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247935830,"owners_count":21020898,"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.792Z","updated_at":"2025-04-08T22:32:08.848Z","avatar_url":"https://github.com/oddbird.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Portfoliyo\n==========\n\nDevelopment\n-----------\n\nIf you want to run this project in a `virtualenv`_ to isolate it from\nother Python projects on your system, create a virtualenv and activate\nit.  Then run ``bin/install-reqs`` to install the dependencies for this\nproject into your Python environment.\n\nIn order to run Portfoliyo (or its tests), you'll need a PostgreSQL\ndatabase. By default, Portfoliyo will look for a PostgreSQL database named\n\"portfoliyo\" on localhost.\n\nYou may need to create a ``portfoliyo/settings/local.py`` file with some\ndetails of your local configuration.  See\n``portfoliyo/settings/local.sample.py`` for a sample that can be copied to\n``portfoliyo/settings/local.py`` and modified.\n\nOnce this configuration is done, you should be able to run ``./manage.py\nsyncdb --migrate``, then ``./manage.py runserver`` and access the site\nin your browser at ``http://localhost:8000``.\n\nYou can run the tests with ``py.test`` (or ``grunt pytest``), or the\n``Selenium`` tests with ``py.test portfoliyo/tests/selenium``.\n\n.. _virtualenv: http://www.virtualenv.org\n.. _Selenium: http://seleniumhq.org\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\nLocal development on this project requires `Node.js`_ \u003e= 0.8.0 for JS linting\nand handlebars template compilation. To install the necessary Node\ndependencies, first ``npm install -g grunt-cli`` (once per system), then ``npm\ninstall`` (whenever ``package.json`` changes).\n\nYou can lint the project's JS with ``grunt jshint``.\n\nYou can compile Handlebars templates in the ``jstemplates/`` directory to the\ncompiled-templates file (``static/js/jstemplates.js``) with ``grunt\nhandlebars``.\n\nYou can compile Sass to CSS with ``grunt compass``. This requires first\ninstalling Bundler (``gem install bundler``) and then running ``bundle\ninstall`` to get the necessary Ruby gems installed.\n\nJust running ``grunt`` will perform all of the above tasks.\n\n``grunt dev`` will watch for changes to local files and automatically perform\nan appropriate selection of the above tasks whenever changes are detected\nto relevant files.\n\nRefer to the Gruntfile.js source and `Grunt`_ documentation for more info.\n\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\n``portfoliyo/settings/prod.py`` should be used as the settings module in a\nproduction deployment in place of ``portfoliyo/settings/default.py`` (set\n``DJANGO_SETTINGS_MODULE=portfoliyo.settings.prod``). Site-specific overrides\ncan still be placed in ``portfoliyo/settings/local.py``.\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\ncollecting static assets from reusable components into a single\ndirectory for production serving.  Under \"runserver\" in development this\nis handled automatically.  In production, run ``./manage.py\ncollectstatic`` to collect all static assets into the\n``collected-assets`` directory (or whatever ``STATIC_ROOT`` is set to in\n``settings_local.py``), and make those collected assets available by\nHTTP at the ``STATIC_URL`` setting.\n\n.. _staticfiles contrib app: http://docs.djangoproject.com/en/1.4/howto/static-files/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddbird%2Fportfoliyo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foddbird%2Fportfoliyo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddbird%2Fportfoliyo/lists"}