Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativecommons/legaldb
CC Legal Database: curated repository of Case Law and Scholarship data from around the world in a Django based website.
https://github.com/creativecommons/legaldb
creative-commons django javascript python
Last synced: 2 days ago
JSON representation
CC Legal Database: curated repository of Case Law and Scholarship data from around the world in a Django based website.
- Host: GitHub
- URL: https://github.com/creativecommons/legaldb
- Owner: creativecommons
- License: mit
- Created: 2018-05-16T19:44:57.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T22:58:11.000Z (about 1 month ago)
- Last Synced: 2024-12-30T20:10:29.957Z (9 days ago)
- Topics: creative-commons, django, javascript, python
- Language: Python
- Homepage: https://LegalDB.CreativeCommons.org/
- Size: 2.26 MB
- Stars: 46
- Watchers: 20
- Forks: 71
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# legaldb
CC Legal Database: curated repository of Case Law and Scholarship data from
around the world in a Django based website.
**[legaldb.creativecommons.org](https://legaldb.creativecommons.org/)**
## Code of conduct
[`CODE_OF_CONDUCT.md`][org-coc]:
> The Creative Commons team is committed to fostering a welcoming community.
> This project and all other Creative Commons open source projects are governed
> by our [Code of Conduct][code_of_conduct]. Please report unacceptable
> behavior to [[email protected]](mailto:[email protected])
> per our [reporting guidelines][reporting_guide].
[org-coc]: https://github.com/creativecommons/.github/blob/main/CODE_OF_CONDUCT.md
[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
## Contributing
See [`CONTRIBUTING.md`][org-contrib].
[org-contrib]: https://github.com/creativecommons/.github/blob/main/CONTRIBUTING.md
## Development setup
For information on learning and installing the prerequisite technologies for this project, please see [Foundational technologies — Creative Commons Open Source][found-tech].
[found-tech]: https://opensource.creativecommons.org/contributing-code/foundational-tech/
Copy `.env.template` and set environment variables (like
`DJANGO_DEBUG_ENABLED=True` for local development and testing) and secret keys
in a `.env` file.
Please read the comments in the `.env` file for specific instructions to get it to work locally.
```shell
cp .env.template .env
```
### Using docker compose
#### Start (and Build) the Servers
Start Django server (backed by PostgreSQL server ) at
[127.0.0.1:8000](http://127.0.0.1:8000/):
```sh
docker compose up
```
#### Initialize database with development data
The following utility will reset the database, run migrations, configure an
admin user, and load the developiment data:
1. In a terminal window / command line:
```shell
docker compose up
```
2. In a second terminal window /command line:
```shell
./bin/init_data.sh
```
#### Helper commands
All of the following helper commands assume the App and DB services are
running:
- [`bin/check.sh`](bin/check.sh)
- _Perform static analysis checks and reformat Python code_
- ~~[`bin/dump_data.sh`](bin/check.sh)~~
- ~~_Dump Django data with processing to remove PII and unapproved
entries_~~
- Not normally invoked during development
- [`bin/init_data.sh`](bin/init_data.sh)
- _Initialize Django application data (!!DANGER!!)_
- ~~[`process_data.py`](bin/process_data.py)~~
- ~~_Process YAML data from Django dumpdata to remove PII and unapproved
entries._~~
- ~~called by `bin/dump_data`~~
- Not normally invoked during development
- ~~[`bin/release_tasks`](bin/release_tasks)~~
- ~~Heroku release script~~
- Not normally invoked during development
- [`bin/test.sh`](bin/check.sh)
- _Run Django collectstatic, check, and test (unit tests)_
#### Execute Commands
To execute any commands inside the app docker container, follow this format:
```shell
docker compose exec app ./manage.py DJANGO COMMAND HERE
```
or
```shell
docker compose exec app sh -c "SHELL COMMAND HERE"
```
Examples:
- Create a Super User:
```shell
docker compose exec app ./manage.py createsuperuser
```
- (better to use `bin/init_data.sh`)
- Collect static files:
```shell
docker compose exec app ./manage.py collectstatic
```
- Compress content:
```shell
docker compose exec app ./manage.py compress
```
- Run tests:
```shell
docker compose exec app ./manage.py test
```
- (better to use `bin/test.sh`)
### Pipenv
The Python modules are managed by [Pipenv](https://pipenv.pypa.io/en/latest/).
If development requires new Python modules, remember to also rebuild your
Docker containters.
### Webpack
Open another terminal and navigate to webpack folder using:
```shell
cd webpack
```
To install webpack dependencies use:
```shell
npm install
```
or alternatively to install from package-lock.json use:
```shell
npm ci
```
If you want to make changes to scss files during development run:
```shell
npm run watch
```
otherwise run the following command
```shell
npm run build
```
After made code changes and before commit, check code style from main directory using.
### Code Style
After making changes in code and before commit, check code style:
```shell
./bin/check.sh
```
### Development Blog Posts
[Posts in the Outreachy May 2020 round: CC Legal Database series][blogseries]
[blogseries]: https://opensource.creativecommons.org/blog/entries/legal-database-a-new-beginning/#series
## Guides
The [`guides/`](guides/) folder includes:
- **[`README.md`](guides/README.md)**
- [`deploy_to_heroku.md`](guides/deploy_to_heroku.md)
- [`technologies_used_guide.md`](guides/technologies_used_guide.md)
## License
- [`LICENSE`](LICENSE) (Expat/[MIT][mit] License)
[mit]: http://www.opensource.org/licenses/MIT "The MIT License | Open Source Initiative"