Skip to content

Commit 04ace2f

Browse files
chore: remove old dependencies and unused code
1 parent 320fdb5 commit 04ace2f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+2848
-8635
lines changed

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,24 @@
33

44
<p align="center">
55
<img alt="django-react-typescript logo" src="assets/Logo.png" />
6-
<p align="center">Fully-featured, up-to-date React-Django boilerplate with great.</p>
6+
<p align="center">Fully-featured, Django v5 + React v18 boilerplate with great DX.</p>
77
</p>
88

99
---
1010

11-
This is a fully-featured Django-React boilerplate built for great development experience and easy deployment.
11+
This is a fully-featured Django + React boilerplate built for great development experience and easy deployment guidelines.
1212

13-
## Development
13+
## Getting started
1414

15-
### Database
15+
After cloning this project, install all dependencies by running:
16+
17+
```sh
18+
pnpm run bootstrap
19+
```
20+
21+
This command will install all dependencies for the frontend (React) and backend (Django) apps.
22+
23+
### Setting up a database
1624

1725
To start developing on this project, you will need a Postgres database instance running. It doesn 't matter if it's a local instance or a remote one. Just make sure to set up a Postgres database and configure the `.env` file with the correct credentials.
1826

@@ -22,6 +30,36 @@ For convenience, if you want to use Docker + Docker Compose to spin up a Postgre
2230
pnpm run dev:db:up
2331
```
2432

33+
### Running the project
34+
35+
Once you've set up the database, you can start the project by running one of:
36+
37+
```sh
38+
pnpm dev # Starts the project while assuming you've setup a database not using the Docker Compose setup. Spins up only the backend and frontend apps
39+
pnpm dev:full # Starts the project while assuming you've setup a database using the Docker Compose setup. Spins up a Postgres instance and pgAdmin alongside the backend and frontend apps
40+
```
41+
42+
By default, the frontend app will run on `localhost:4000` and the backend app will run on `localhost:8000`. If you're running the containerized Postgres, it will run on `localhost:5432` and pgAdmin will run on `localhost:5050`.
43+
44+
## Application architecture
45+
46+
This application's architect is quite simple and leverages the best of both Django and React. On a nutshell, React and Django integrate through Django's Views and Django Rest Framework's API endpoints.
47+
48+
```mermaid
49+
flowchart TD
50+
ns("Frontend") --> ny("React") & n9("Env. variables")
51+
nl("Backend") --> nt("Django") & ni("Django Rest Framework")
52+
nt --> n5("Views") & nb("Templates") & na("Models")
53+
n5 --> nb
54+
ny --> n0("API Client") & n4("Root Container")
55+
na --> nn("API Key") & nd("Publications")
56+
n4 -- Mounts on same file from\nDjango templates --> nb
57+
n9 -.-> nn & n0
58+
ni -- Provides a REST\nendpoint to manipulate\ndata from models --> ng("REST API")
59+
ng --> nd
60+
n0 -- Consumes API Key\nto authenticate\nwith backend --> ng
61+
```
62+
2563
### Global
2664

2765
- Commit lint rules
@@ -31,8 +69,6 @@ pnpm run dev:db:up
3169
- [React](https://reactjs.org/)
3270
- [Typescript](https://www.typescriptlang.org/)
3371
- [React Router](https://reactrouter.com/)
34-
- [Styled Components](https://styled-components.com/)
35-
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
3672
- [Webpack](https://webpack.js.org/)
3773

3874
| Other features | Status |

frontend/.unimportedrc.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"ignorePatterns": [
3+
"**/node_modules/**",
4+
"**/*.tests.{js,jsx,ts,tsx}",
5+
"**/*.test.{js,jsx,ts,tsx}",
6+
"**/*.spec.{js,jsx,ts,tsx}",
7+
"**/tests/**",
8+
"**/__tests__/**",
9+
"**/*.d.ts"
10+
],
11+
"ignoreUnimported": [],
12+
"ignoreUnused": [],
13+
"ignoreUnresolved": [],
14+
"respectGitignore": true
15+
}

frontend/base/Box/index.ts

Lines changed: 0 additions & 4 deletions
This file was deleted.

frontend/base/Fade/index.ts

Lines changed: 0 additions & 29 deletions
This file was deleted.

frontend/base/Flex/index.ts

Lines changed: 0 additions & 15 deletions
This file was deleted.

frontend/base/Image/index.ts

Lines changed: 0 additions & 15 deletions
This file was deleted.

frontend/base/Separator/index.ts

Lines changed: 0 additions & 29 deletions
This file was deleted.

frontend/base/index.ts

Lines changed: 0 additions & 5 deletions
This file was deleted.

frontend/components/BackButton/index.tsx

Lines changed: 0 additions & 21 deletions
This file was deleted.

frontend/components/BackButton/style.ts

Lines changed: 0 additions & 12 deletions
This file was deleted.

frontend/components/Button/__tests__/index.tsx

Lines changed: 0 additions & 32 deletions
This file was deleted.

frontend/components/Button/index.tsx

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)