{"id":13904970,"url":"https://github.com/creativecommons/legaldb","last_synced_at":"2025-04-05T06:04:20.201Z","repository":{"id":39969158,"uuid":"133715391","full_name":"creativecommons/legaldb","owner":"creativecommons","description":"CC Legal Database: curated repository of Case Law and Scholarship data from around the world in a Django based website.","archived":false,"fork":false,"pushed_at":"2025-01-08T18:15:22.000Z","size":2383,"stargazers_count":51,"open_issues_count":20,"forks_count":74,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-03-29T05:02:10.837Z","etag":null,"topics":["creative-commons","django","javascript","python"],"latest_commit_sha":null,"homepage":"https://LegalDB.CreativeCommons.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/creativecommons.png","metadata":{"funding":{"github":["creativecommons"],"custom":["https://creativecommons.org/donate"]},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-16T19:44:57.000Z","updated_at":"2025-03-27T18:59:18.000Z","dependencies_parsed_at":"2023-02-09T16:31:03.087Z","dependency_job_id":"af7c4530-6d4a-432a-911f-33b21038d968","html_url":"https://github.com/creativecommons/legaldb","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/creativecommons%2Flegaldb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativecommons%2Flegaldb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativecommons%2Flegaldb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativecommons%2Flegaldb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/creativecommons","download_url":"https://codeload.github.com/creativecommons/legaldb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294527,"owners_count":20915340,"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":["creative-commons","django","javascript","python"],"created_at":"2024-08-06T23:01:07.699Z","updated_at":"2025-04-05T06:04:20.183Z","avatar_url":"https://github.com/creativecommons.png","language":"Python","funding_links":["https://github.com/sponsors/creativecommons","https://creativecommons.org/donate"],"categories":["HTML"],"sub_categories":[],"readme":"# legaldb\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/creativecommons/caselaw/blob/master/LICENSE\"\u003e\u003cimg alt=\"MIT license\" src=\"https://img.shields.io/github/license/creativecommons/vocabulary.svg?color=brightgreen\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nCC Legal Database: curated repository of Case Law and Scholarship data from\naround the world in a Django based website.\n\n**[legaldb.creativecommons.org](https://legaldb.creativecommons.org/)**\n\n\n## Code of conduct\n\n[`CODE_OF_CONDUCT.md`][org-coc]:\n\u003e The Creative Commons team is committed to fostering a welcoming community.\n\u003e This project and all other Creative Commons open source projects are governed\n\u003e by our [Code of Conduct][code_of_conduct]. Please report unacceptable\n\u003e behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org)\n\u003e per our [reporting guidelines][reporting_guide].\n\n[org-coc]: https://github.com/creativecommons/.github/blob/main/CODE_OF_CONDUCT.md\n[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/\n[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/\n\n\n## Contributing\n\nSee [`CONTRIBUTING.md`][org-contrib].\n\n[org-contrib]: https://github.com/creativecommons/.github/blob/main/CONTRIBUTING.md\n\n\n## Development setup\n\nFor information on learning and installing the prerequisite technologies for this project, please see [Foundational technologies — Creative Commons Open Source][found-tech].\n\n[found-tech]: https://opensource.creativecommons.org/contributing-code/foundational-tech/\n\nCopy `.env.template` and set environment variables (like\n`DJANGO_DEBUG_ENABLED=True` for local development and testing) and secret keys\nin a `.env` file.\n\nPlease read the comments in the `.env` file for specific instructions to get it to work locally.\n\n```shell\ncp .env.template .env\n```\n\n\n### Using docker compose\n\n\n#### Start (and Build) the Servers\n\nStart Django server (backed by PostgreSQL server ) at\n[127.0.0.1:8000](http://127.0.0.1:8000/):\n```sh\ndocker compose up\n```\n\n\n#### Initialize database with development data\n\nThe following utility will reset the database, run migrations, configure an\nadmin user, and load the developiment data:\n1. In a terminal window / command line:\n    ```shell\n    docker compose up\n    ```\n2. In a second terminal window /command line:\n    ```shell\n    ./bin/init_data.sh\n    ```\n\n#### Helper commands\n\nAll of the following helper commands assume the App and DB services are\nrunning:\n- [`bin/check.sh`](bin/check.sh)\n  - _Perform static analysis checks and reformat Python code_\n- ~~[`bin/dump_data.sh`](bin/check.sh)~~\n  - ~~_Dump Django data with processing to remove PII and unapproved\n    entries_~~\n  - Not normally invoked during development\n- [`bin/init_data.sh`](bin/init_data.sh)\n  - _Initialize Django application data (!!DANGER!!)_\n- ~~[`process_data.py`](bin/process_data.py)~~\n  - ~~_Process YAML data from Django dumpdata to remove PII and unapproved\n    entries._~~\n  - ~~called by `bin/dump_data`~~\n  - Not normally invoked during development\n- ~~[`bin/release_tasks`](bin/release_tasks)~~\n  - ~~Heroku release script~~\n  - Not normally invoked during development\n- [`bin/test.sh`](bin/check.sh)\n  - _Run Django collectstatic, check, and test (unit tests)_\n\n\n#### Execute Commands\n\nTo execute any commands inside the app docker container, follow this format:\n\n```shell\ndocker compose exec app ./manage.py DJANGO COMMAND HERE\n```\nor\n```shell\ndocker compose exec app sh -c \"SHELL COMMAND HERE\"\n```\n\nExamples:\n- Create a Super User:\n    ```shell\n    docker compose exec app ./manage.py createsuperuser\n    ```\n  - (better to use `bin/init_data.sh`)\n- Collect static files:\n    ```shell\n    docker compose exec app ./manage.py collectstatic\n    ```\n- Compress content:\n    ```shell\n    docker compose exec app ./manage.py compress\n    ```\n- Run tests:\n    ```shell\n    docker compose exec app ./manage.py test\n    ```\n  - (better to use `bin/test.sh`)\n\n\n### Pipenv\n\nThe Python modules are managed by [Pipenv](https://pipenv.pypa.io/en/latest/).\nIf development requires new Python modules, remember to also rebuild your\nDocker containters.\n\n\n### Webpack\n\nOpen another terminal and navigate to webpack folder using:\n```shell\ncd webpack\n```\n\nTo install webpack dependencies use:\n```shell\nnpm install\n```\nor alternatively to install from package-lock.json use:\n```shell\nnpm ci\n```\n\nIf you want to make changes to scss files during development run:\n```shell\nnpm run watch\n```\n\notherwise run the following command\n```shell\nnpm run build\n```\n\nAfter made code changes and before commit, check code style from main directory using.\n\n\n### Code Style\n\nAfter making changes in code and before commit, check code style:\n```shell\n./bin/check.sh\n```\n\n\n### Development Blog Posts\n\n[Posts in the Outreachy May 2020 round: CC Legal Database series][blogseries]\n\n[blogseries]: https://opensource.creativecommons.org/blog/entries/legal-database-a-new-beginning/#series\n\n\n## Guides\n\nThe [`guides/`](guides/) folder includes:\n- **[`README.md`](guides/README.md)**\n- [`deploy_to_heroku.md`](guides/deploy_to_heroku.md)\n- [`technologies_used_guide.md`](guides/technologies_used_guide.md)\n\n\n## License\n\n- [`LICENSE`](LICENSE) (Expat/[MIT][mit] License)\n\n[mit]: http://www.opensource.org/licenses/MIT \"The MIT License | Open Source Initiative\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreativecommons%2Flegaldb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcreativecommons%2Flegaldb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreativecommons%2Flegaldb/lists"}