Skip to content

Commit 942d15b

Browse files
committed
fix: update dependencies and improve README instructions
1 parent 91d7788 commit 942d15b

4 files changed

Lines changed: 609 additions & 435 deletions

File tree

.editorconfig

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ root = true
33
[*]
44
charset = utf-8
55
end_of_line = lf
6-
indent_size = 2
76
indent_style = space
8-
insert_final_newline = true
9-
max_line_length = 120
7+
indent_size = 2
108
tab_width = 2
9+
max_line_length = 120
10+
insert_final_newline = true
1111
trim_trailing_whitespace = true
1212

13+
1314
[*.html]
1415
max_line_length = 240
1516

@@ -18,6 +19,6 @@ tab_width = 4
1819
indent_style = tab
1920
max_line_length = 240
2021

21-
[*.py]
22+
[{*.py,*.md}]
2223
indent_size = 4
2324
tab_width = 4

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212

1313
[See the project live][link-production]
1414

15-
1615
[Contributing](#contributing) | [Built with](#built-with) | [Feedback](#feedback) | [License](#license) | [About Code for Romania](#about-code-for-romania)
1716

1817
## Contributing
@@ -33,22 +32,22 @@ would like the UI to look like if you’re suggesting new UI elements.
3332

3433
### Programming languages
3534

36-
- Backend: [Python3.12](https://www.python.org/)
35+
- Backend: [Python3.13(https://www.python.org/)
3736

3837
### Platforms
3938

4039
- [AWS](https://aws.amazon.com/) through [Terraform](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
4140

4241
### Frontend framework
4342

44-
- HTML + TailwindCSS + AlpineJS
43+
- HTML Django Templates + TailwindCSS + AlpineJS
4544

4645
### Package managers
4746

48-
- [pip-tools](https://pip-tools.rtfd.io/)
47+
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
4948
- [npm](https://www.npmjs.com/)
5049

51-
### Database technology & provider
50+
### Database technology and provider
5251

5352
- [PostgreSQL](https://www.postgresql.org/)
5453

@@ -58,33 +57,34 @@ would like the UI to look like if you’re suggesting new UI elements.
5857

5958
#### Prerequisites
6059

61-
- Python 3.12
60+
- Python 3.13
61+
- [UV](https://docs.astral.sh/uv/getting-started/installation/)
6262
- [NVM](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating)
6363
- a PostgreSQL 16.4 database (can be run with Docker)
6464

6565
1. Go to the root of the project
6666
2. Run `cp .env.example .env.local` to create the environment file
67-
3. Configure your database to run with the configuration in the `.env.local` file
68-
or run the database using docker with `docker compose up -d db_psql_dev` or `make rund-db`
67+
3. Configure your database to run with the configuration in the `.env.local` file or run the database using docker with
68+
`docker compose up -d db_psql_dev` or `make rund-db`
6969
4. Set up the Node.js environment
70-
1. Go to the `backend` directory
71-
2. Run `nvm use || nvm install` to install the Node.js version specified in the `.nvmrc` file
72-
3. Run `npm install` to install the Node.js dependencies
70+
1. Go to the `backend` directory
71+
2. Run `nvm use || nvm install` to install the Node.js version specified in the `.nvmrc` file
72+
3. Run `npm install` to install the Node.js dependencies
7373
5. Set up the Python environment
74-
1. Create a virtual environment and activate it with `python3 -m venv venv && source venv/bin/activate`
75-
2. Go to the `backend` directory
76-
3. Run `pip install -r requirements-dev.txt` to install the Python dependencies
74+
1. Go to the `backend` directory
75+
2. Create a virtual environment with `uv venv --python 3.13`
76+
3. Run `uv sync --active` to install the Python dependencies
7777

7878
#### Running the project
7979

8080
1. Run the Django project in one terminal
81-
1. Go to the `backend` directory
82-
2. Run `source venv/bin/activate` to activate the Python virtual environment
83-
3. Run `django-admin runserver localhost:8000` to start the Django development server
81+
1. Go to the `backend` directory
82+
2. Run `source .venv/bin/activate` to activate the Python virtual environment
83+
3. Run `django-admin runserver localhost:8000` to start the Django development server
8484
2. Run the frontend in another terminal
85-
1. Go to the `backend` directory
86-
2. Run `nvm use` to use the Node.js version specified in the `.nvmrc` file
87-
3. Run `npm run dev` to start the frontend development server
85+
1. Go to the `backend` directory
86+
2. Run `nvm use` to use the Node.js version specified in the `.nvmrc` file
87+
3. Run `npm run dev` to start the frontend development server
8888
3. Open http://localhost:8000 in your browser
8989

9090
:information_source:
@@ -96,7 +96,6 @@ For the frontend, set the `DJANGO_VITE_DEV_SERVER_PORT` variable in the `.env.lo
9696
**In case of problems with the instructions**, please open an issue.
9797
If you managed to find a solution, please open a PR with the changes.
9898

99-
10099
### Deployment With Docker
101100

102101
1. Go to the root of the project
@@ -132,16 +131,23 @@ to support us, [you can do it here][link-donate].
132131
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job.)
133132

134133
[ico-contributors]: https://img.shields.io/github/contributors/code4romania/redirectioneaza.svg?style=for-the-badge
134+
135135
[ico-last-commit]: https://img.shields.io/github/last-commit/code4romania/redirectioneaza.svg?style=for-the-badge
136+
136137
[ico-license]: https://img.shields.io/badge/license-MPL%202.0-brightgreen.svg?style=for-the-badge
137138

138139
[link-contributors]: https://github.com/code4romania/redirectioneaza/graphs/contributors
140+
139141
[link-last-commit]: https://github.com/code4romania/redirectioneaza/commits/main
142+
140143
[link-license]: https://opensource.org/licenses/MPL-2.0
144+
141145
[link-contributing]: https://github.com/code4romania/.github/blob/main/CONTRIBUTING.md
142146

143147
[link-production]: https://redirectioneaza.ro
148+
144149
[link-staging]: https://redirectioneaza.staging.heroesof.tech/
145150

146151
[link-code4]: https://www.code4.ro/en/
152+
147153
[link-donate]: https://code4.ro/en/donate/

backend/pyproject.toml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description = "A tool to help NGOs with managing the redirection of people's tax
55

66
requires-python = ">=3.13"
77
dependencies = [
8-
"blessed~=1.21.0",
9-
"cryptography~=45.0.7",
8+
"blessed~=1.22.0",
9+
"cryptography~=46.0.3",
1010
"django~=5.2.0",
1111
"django-allauth~=65.7",
1212
"django-environ~=0.12",
@@ -22,20 +22,20 @@ dependencies = [
2222
# pinned because of a bug in >=0.54.0
2323
"django-unfold==0.53.0",
2424
"django-vite~=3.1",
25-
"gevent~=25.8.2",
25+
"gevent~=25.9.1",
2626
"gunicorn~=23.0.0",
2727
"ngohub~=0.1.0",
2828
"phonenumbers~=9.0",
29-
"psutil~=7.0.0",
30-
"psycopg2-binary~=2.9.9",
29+
"psutil~=7.1.2",
30+
"psycopg2-binary~=2.9.11",
3131
"pycognito~=2024.5.1",
3232
"pydantic[email]~=2.11",
3333
"pymysql~=1.1",
34-
"pypdf~=6.0.0",
34+
"pypdf~=6.1.3",
3535
"reportlab~=4.4",
3636
"requests~=2.32.3",
3737
"sentry-sdk[django]~=2.27",
38-
"svglib~=1.5.1",
38+
"svglib~=1.6.0",
3939
"whitenoise~=6.9",
4040
]
4141

@@ -44,12 +44,12 @@ dependencies = [
4444
test = [
4545
"faker~=37.1",
4646
"pytest~=8.4.1",
47-
"pytest-cov~=6.2.1",
47+
"pytest-cov~=7.0.0",
4848
"pytest-django~=4.11.1",
4949
"pytest-xdist~=3.8.0",
5050
]
5151
ruff = [
52-
"ruff~=0.12.11"
52+
"ruff~=0.14.2"
5353
]
5454
dev = [
5555
"debugpy~=1.8.14",

0 commit comments

Comments
 (0)