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 hacktoberfest javascript python
Last synced: about 1 month 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-07-10T18:35:47.000Z (2 months ago)
- Last Synced: 2024-07-27T19:46:22.877Z (about 2 months ago)
- Topics: creative-commons, django, hacktoberfest, javascript, python
- Language: HTML
- Homepage: https://LegalDB.CreativeCommons.org/
- Size: 1.28 MB
- Stars: 38
- Watchers: 20
- Forks: 35
- Open Issues: 4
-
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
Copy `.env.template` and set environment variables (like
`DJANGO_DEBUG_ENABLED=True` for local development and testing) and secret keys
in a `.env` file.
```shell
cp .env.template .env
```
### Using docker compose
Ensure that you have Docker and Docker Compose installed on your system
For installation instructions refer: [Get Docker | Docker
Documentation](https://docs.docker.com/get-docker/)
#### 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
```
#### Run Migrations
Run the migrations to create database schema (we use Postgresql in this case):
```shell
docker compose exec app ./manage.py migrate
```
**(Required after initial build)**
#### 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
```
- 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
```
### Using Pipenv
NOTE: The prefered method is [Using docker compose](#using-docker-compose).
To follow these instructions, Python 3 and
[Pipenv](https://pipenv.pypa.io/en/latest/) are required.
Install dependencies with pipenv.
```shell
pipenv install --dev
```
Run the migrations to create the database (we use
Postgresql in this case).
```shell
pipenv run ./manage.py migrate
```
The next step is to create an admin account for Django admin.
```shell
pipenv run ./manage.py createsuperuser
```
Finally you can start a development server with:
```shell
pipenv run ./manage.py runserver
```
and see a local version of the website at
[127.0.0.1:8000](http://127.0.0.1:8000/).
### 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
pipenv run isort .
pipenv run black .
pipenv run flake8 .
```
### 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
## Deploy to Heroku
See [`deploy_to_heroku.md`](deploy_to_heroku.md).
## License
- [`LICENSE`](LICENSE) (Expat/[MIT][mit] License)
[mit]: http://www.opensource.org/licenses/MIT "The MIT License | Open Source Initiative"