Skip to content

Commit

Permalink
chore: inserted pre-commit instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
raffaellasuardini authored and tim-schilling committed Apr 23, 2024
1 parent f5cfeab commit a529e36
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,15 @@ This is an example of how to list things you need to use the software and how to
```sh
venv\Scripts\activate
```
3. Create a posgresql database
3. Install pre-commit
```sh
pip install pre-commit
```
Install git hook scripts:
```sh
pre-commit install
```
4. Create a posgresql database
```sh
psql -U postgres
```
Expand All @@ -140,12 +148,12 @@ This is an example of how to list things you need to use the software and how to
```sh
postgres=# exit
```
4. install requirements:
5. install requirements:
```sh
pip install -r requirements/requirements-dev.txt
```

5. Copy `.env.template.local` file, rename to `.env` and use variables for your local postgres database.
6. Copy `.env.template.local` file, rename to `.env` and use variables for your local postgres database.
Copy in Linux:
```sh
cp .env.template.local .env
Expand All @@ -154,22 +162,22 @@ This is an example of how to list things you need to use the software and how to
```sh
copy .env.template.local .env
```
6. Run migrations and create superuser
7. Run migrations and create superuser
```sh
python manage.py migrate
# Potentially load data first
# python manage.py loaddata fixtures/data.json
python manage.py createsuperuser
```
7. Install tailwind. You also need npm installed.
8. Install tailwind. You also need npm installed.
```sh
python manage.py tailwind install
```
8. Run server locally
9. Run server locally
```sh
python manage.py runserver
```
9. Run tailwind in another terminal locally
10. Run tailwind in another terminal locally
```sh
python manage.py tailwind start
```
Expand Down

0 comments on commit a529e36

Please sign in to comment.