{"id":14036918,"url":"https://github.com/CityOfNewYork/NYCOpenRecords","last_synced_at":"2025-07-27T04:33:06.442Z","repository":{"id":33035972,"uuid":"36671696","full_name":"CityOfNewYork/NYCOpenRecords","owner":"CityOfNewYork","description":"A web application to submit and view Freedom of Information Law requests","archived":false,"fork":false,"pushed_at":"2024-08-05T13:51:55.000Z","size":50957,"stargazers_count":48,"open_issues_count":6,"forks_count":12,"subscribers_count":13,"default_branch":"develop","last_synced_at":"2024-08-05T16:00:46.520Z","etag":null,"topics":["foil","government","government-data","nyc","openrecords","transparency"],"latest_commit_sha":null,"homepage":"http://nyc.gov/openrecords","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CityOfNewYork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-06-01T15:56:23.000Z","updated_at":"2024-07-21T02:32:40.000Z","dependencies_parsed_at":"2023-02-15T11:00:38.282Z","dependency_job_id":"4a312c21-7cbc-4947-bad0-8df465976a66","html_url":"https://github.com/CityOfNewYork/NYCOpenRecords","commit_stats":null,"previous_names":[],"tags_count":71,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CityOfNewYork%2FNYCOpenRecords","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CityOfNewYork%2FNYCOpenRecords/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CityOfNewYork%2FNYCOpenRecords/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CityOfNewYork%2FNYCOpenRecords/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CityOfNewYork","download_url":"https://codeload.github.com/CityOfNewYork/NYCOpenRecords/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":214982086,"owners_count":15811653,"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":["foil","government","government-data","nyc","openrecords","transparency"],"created_at":"2024-08-12T03:02:19.334Z","updated_at":"2024-12-02T16:31:13.836Z","avatar_url":"https://github.com/CityOfNewYork.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cimg src=\"https://www1.nyc.gov/assets/records/images/content/header/logo.png\" alt=\"NYC Department of Records and Information Services\" width=\"200px\" /\u003e\u003cimg src=\"https://a860-openrecords.nyc.gov/static/img/logo.png\" alt=\"NYC OpenRecords\" width=\"200px\" /\u003e  \n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2b97fe8319344d699a4bbba48827637b)](https://www.codacy.com/app/NYCRecords/NYCOpenRecords?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=CityOfNewYork/NYCOpenRecords\u0026amp;utm_campaign=Badge_Grade)\n\n# NYC OpenRecords\nNYC OpenRecords is an application that assists individuals in the process of submitting Freedom of Information Law (FOIL) requests to a NYC Agency. The web application also allows government employees to manage, respond to, and fulfill incoming requests.\n\n## Getting Started\n\n### Technical Requirements\nOpenRecords is currently being developed on RedHat Enterprise Linux v6 / v7 (in testing). \n\nIt relies on the following technologies:\n- Python v3.5 \n- PostgreSQL v9.5\n- ElasticSearch v5.2\n- Redis v3.2\n\nAuthentication \n- OpenRecords currently implements LDAP and OAuth for authentication. For development, you can bypass authentication by setting both `'USE_OAUTH'` and `'USE_LDAP'` to `False`.\n    \nWe have optional integrations with [Sentry](https://sentry.io) for error tracing and are working on an integration with the ELK stack for log aggregation and analytics.\n\n### Pre-Requisites\n- Vagrant (v2.1.4) - Newer version may work but have not been tested.\n- Virtualbox (v5.1.32) - Newer versions may work but have not been tested.\n- [Vagrant-VBGuest](https://github.com/dotless-de/vagrant-vbguest)\n- Redhat Developer Account (https://developers.redhat.com)\n- FakeSMTP (Optional, for testing email functionality)\n\n### Setting Up Development Environment (WIP)\n\n#### On Mac OS X:\n1. Install Virtualbox and Vagrant.\n2. Install vagrant-vbguest:\n    ```bash\n    vagrant plugin install vagrant-vbguest\n    ```\n3. Create your `.env` file:\n    ```bash\n    cp .env.example .env\n    ```\n4. Edit your `.env` file. Look at the comments in `.env.example` and `config.py` for examples of valid values.\n5. Create your `Vagrantfile`\n    ```bash\n    cp Vagrantfile.example Vagrantfile\n    ```\n5. Startup your Vagrant machine \n    ```bash\n    RH_USER=\u003cYOUR REDHAT DEVELOPER USERNAME\u003e RH_PASS=\u003cYOUR REDHAT DEVELOPER PASSWORD\u003e vagrant up default\n    \n    ```\n6. Once Vagrant has finished setting up the VM, ssh in to the system (`vagrant ssh`). You'll need to have 2 different SSH Sessions open.\n    Terminal 1 - Celery\n    ```bash\n    sh /vagrant/.startup/celery_startup.sh\n    ```\n    Terminal 2 - Flask\n    ```bash\n    sh /vagrant/.startup/flask_startup.sh\n    ```\n    \n#### On Windows:\n**TBD** (If you would like to help us setup a development environment on Windows, please try it out and submit issues as they come up.)\n    \n## Questions?\nPlease open an issue in this repository if you have any questions or any difficulty setting up and using OpenRecords.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCityOfNewYork%2FNYCOpenRecords","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCityOfNewYork%2FNYCOpenRecords","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCityOfNewYork%2FNYCOpenRecords/lists"}