Skip to content

Commit 7ad2650

Browse files
committed
minor fixes and updated readme
1 parent 0e1963d commit 7ad2650

File tree

3 files changed

+39
-15
lines changed

3 files changed

+39
-15
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ _site
99
__pycache__/
1010
staticfiles/
1111
venv/
12-
node_modules/
12+
node_modules/

README.md

+37-13
Original file line numberDiff line numberDiff line change
@@ -9,77 +9,101 @@ CC Legal Database: curated repository of Case Law and Scholarship data from arou
99

1010
**[legaldb.creativecommons.org](https://legaldb.creativecommons.org/)**
1111

12-
1312
## Code of Conduct
1413

1514
Please note that this project is released with a Contributor [Code of
1615
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to
1716
abide by its terms.
1817

19-
2018
## Contributing
2119

2220
See [`CONTRIBUTING.md`](CONTRIBUTING.md). It contains some general instructions
2321
that should be followed when contributing to any of the Creative Commons
2422
open-source repositories.
2523

26-
2724
### Development setup
2825

29-
To follow these instructions, Python 3 and
30-
[Pipenv](https://pipenv.pypa.io/en/latest/) are required.
26+
To follow these instructions, Python 3,
27+
[Pipenv](https://pipenv.pypa.io/en/latest/) and node are required.
3128

3229
Install dependencies with pipenv.
30+
3331
```shell
3432
pipenv install --dev
3533
```
3634

3735
Copy `.env.template` and set environment variables (like
3836
`DJANGO_DEBUG_ENABLED=True` for local development and testing) and secret keys
3937
in a `.env` file.
38+
4039
```shell
4140
cp .env.template .env
4241
```
4342

4443
After setting variables run the migrations to create the database (we use
4544
Postgresql in this case).
45+
4646
```shell
4747
pipenv run python manage.py migrate
4848
```
4949

5050
The next step is to create an admin account for Django admin.
51+
5152
```shell
5253
pipenv run python manage.py createsuperuser
5354
```
5455

5556
Finally you can start a development server with:
57+
5658
```shell
5759
pipenv run python manage.py runserver
5860
```
61+
5962
and see a local version of the website following `http://127.0.0.1:8000/` on
6063
the browser.
6164

62-
After made code changes and before commit, check code style.
65+
Open another terminal and navigate to webpack folder using:
66+
67+
```shell
68+
cd webpack
69+
```
70+
71+
To install webpackdependencies with:
72+
73+
```shell
74+
npm install
75+
```
76+
77+
If you want to make changes to scss files during development run:
78+
79+
```shell
80+
npm run watch
81+
```
82+
83+
otherwise run the following command
84+
85+
```shell
86+
npm run build
87+
```
88+
89+
After made code changes and before commit, check code style from main directory using.
90+
6391
```shell
6492
pipenv run black .
6593
pipenv run flake8
6694
```
6795

68-
6996
### Development Blog Posts
7097

7198
[Posts in the Outreachy May 2020 round: CC Legal Database series][blogseries]
7299

73-
[blogseries]: https://opensource.creativecommons.org/blog/entries/legal-database-a-new-beginning/#series
74-
75-
76100
## Deploy to Heroku
77101

78102
See [`deploy_to_heroku.md`](deploy_to_heroku.md).
79103

80-
81104
## License
82105

83-
- [`LICENSE`](LICENSE) (Expat/[MIT][mit] License)
106+
- [`LICENSE`](LICENSE) (Expat/[MIT] License)
84107

85-
[mit]: http://www.opensource.org/licenses/MIT "The MIT License | Open Source Initiative"
108+
[blogseries]: https://opensource.creativecommons.org/blog/entries/legal-database-a-new-beginning/#series
109+
[mit]: http://www.opensource.org/licenses/MIT

webpack/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
import './sass/styles.scss';
1+
import './sass/styles.scss';

0 commit comments

Comments
 (0)