|
| 1 | +--- |
| 2 | +title: Django React Berry - Open-Source Starter |
| 3 | +sidebar_label: Django React Berry |
| 4 | +--- |
| 5 | + |
| 6 | +# Django React Berry Dashboard |
| 7 | + |
| 8 | +<SubHeading> Open-source Full Stack seed project built in React and Django on top of Berry Dashboard </SubHeading> |
| 9 | + |
| 10 | +Full-Stack Seed project generated by **[React App Generator](https://appseed.us/generator/react/)** top of *Berry Dashboard* design. |
| 11 | +The backend logic is provided by a simple, `easy-to-extend` API Server that manages the Authentication flow (login, registration, logout) using `JSON Web Tokens` (JWT). |
| 12 | +Design crafted by [CodedThemes](https://bit.ly/37fF9RT) on top of `MUI` Library. |
| 13 | + |
| 14 | +- 👉 [Django React Berry](https://appseed.us/product/django-react-berry-dashboard) - product page |
| 15 | +- 👉 [Django React Berry](https://django-react-berry-dashboard.appseed-srv1.com/) - LIVE Demo |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +## Product features |
| 21 | + |
| 22 | +The product expects a running API backend that exposes an interface for login/logout and register actions. |
| 23 | +By default, the guest users are redirected to the login page. Once the user is authenticated using an existing account or the new one, all private pages are accessible. |
| 24 | + |
| 25 | + |
| 26 | +## ✨ `React` Berry Dashboard |
| 27 | + |
| 28 | +- `M-UI` based design |
| 29 | +- Modern aesthetics UI design - Designed by *[CodedThemes](https://bit.ly/37fF9RT)* |
| 30 | +- React, Redux, Redux-persist |
| 31 | + |
| 32 | + |
| 33 | +> `Tests` (compatibility matrix using Ubuntu 18 LTS as reference) |
| 34 | +
|
| 35 | +| NodeJS | NPM | YARN | |
| 36 | +| --- | --- | --- | |
| 37 | +| `v14.0.0` | ✅ | ✅ | |
| 38 | +| `v16.0.0` | ✅ | ✅ | |
| 39 | +| `v18.0.0` | ❌ | ❌ | |
| 40 | + |
| 41 | + |
| 42 | +## ✨ `Django API` Features |
| 43 | + |
| 44 | +- Stack: : `Django` / `DRF` / **SQLite** |
| 45 | +- `Up-to-date dependencies` |
| 46 | +- **DB Layer**: Django Native `ORM`, `SQLite` persistence |
| 47 | +- **Auth**: JWT tokens managed via `PyJWT` |
| 48 | +- [API Definition](/boilerplate-code/api-server/api-unified-definition/) - the unified API structure implemented by this server |
| 49 | + |
| 50 | + |
| 51 | +## ✨ How to use it |
| 52 | + |
| 53 | +Being a full-stack product, the backend and the frontend should be compiled and started separately. |
| 54 | +Before starting to compile the product, make sure you have the following tools installed in the environment: |
| 55 | + |
| 56 | +- [NodeJS](https://nodejs.org/en/) - version `14.x` or higher |
| 57 | +- [GIT](https://git-scm.com/) - used to clone tjhe sources from Github |
| 58 | +- [Python3](https://www.python.org/) - used in many tools |
| 59 | + |
| 60 | + |
| 61 | +### 👉 Start the Frontend |
| 62 | + |
| 63 | +> **Step 1** - Once the project is downloaded, change the directory to `react-ui`. |
| 64 | +
|
| 65 | +```bash |
| 66 | +$ cd react-ui |
| 67 | +``` |
| 68 | + |
| 69 | +> **Step 2** - Install dependencies via NPM or yarn |
| 70 | +
|
| 71 | +```bash |
| 72 | +$ npm i |
| 73 | +// OR |
| 74 | +$ yarn |
| 75 | +``` |
| 76 | + |
| 77 | +> **Step 3** - Start in development mode |
| 78 | +
|
| 79 | +```bash |
| 80 | +$ npm run start |
| 81 | +// OR |
| 82 | +$ yarn start |
| 83 | +``` |
| 84 | + |
| 85 | +At this point, the app is available in the browser `localhost:3000` (the default address). |
| 86 | + |
| 87 | + |
| 88 | +### 👉 Start the Backend Server |
| 89 | + |
| 90 | +> **Step 1** - Change the directory to `api-server-django` |
| 91 | +
|
| 92 | +```bash |
| 93 | +$ cd api-server-django |
| 94 | +``` |
| 95 | + |
| 96 | +> **Step 2** - Install dependencies using a `virtual environment` |
| 97 | +
|
| 98 | +```bash |
| 99 | +$ # Virtualenv modules installation (Unix based systems) |
| 100 | +$ virtualenv env |
| 101 | +$ source env/bin/activate |
| 102 | +$ |
| 103 | +$ # Virtualenv modules installation (Windows based systems) |
| 104 | +$ # virtualenv env |
| 105 | +$ # .\env\Scripts\activate |
| 106 | +$ |
| 107 | +$ pip install -r requirements.txt |
| 108 | +``` |
| 109 | + |
| 110 | +> **Step 3** - Setup the database |
| 111 | +
|
| 112 | +```bash |
| 113 | +$ python manage.py makemigrations |
| 114 | +$ python manage.py migrate |
| 115 | +``` |
| 116 | + |
| 117 | +> **Step 4** - Start the API server (development mode) |
| 118 | +
|
| 119 | +```bash |
| 120 | +$ python manage.py runserver 5000 |
| 121 | +``` |
| 122 | + |
| 123 | +Use the API via `POSTMAN` or `Swagger Dashboard` at `localhost:5000`. |
| 124 | + |
| 125 | + |
| 126 | +### 👉 Start API using `Docker` |
| 127 | + |
| 128 | +> **Step 1** - Change the directory to `api-server-django` |
| 129 | +
|
| 130 | +```bash |
| 131 | +$ cd api-server-django |
| 132 | +``` |
| 133 | + |
| 134 | +> **Step 2** - Start API using `docker-compose` command |
| 135 | +
|
| 136 | +```bash |
| 137 | +$ docker-compose up --build |
| 138 | +``` |
| 139 | + |
| 140 | + |
| 141 | +## [React Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/full-stack/) |
| 142 | + |
| 143 | +> For more components, pages and priority on support, feel free to take a look at this amazing starter: |
| 144 | +
|
| 145 | +Berry Dashboard is a premium React Design now available for download as a full-stack app. Made of hundred of elements, designed blocks, and fully coded pages, Berry Dashboard PRO is ready to help you create stunning websites and web apps. |
| 146 | + |
| 147 | +- 👉 [React Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/full-stack/) - Product Page |
| 148 | + - ✅ `Enhanced UI` - more pages and components |
| 149 | + - ✅ `Priority` on support |
| 150 | + |
| 151 | + |
| 152 | + |
| 153 | + |
| 154 | +## Resources |
| 155 | + |
| 156 | +- 👉 More [React Dashboards](https://appseed.us/admin-dashboards/react/) - provided by `AppSeed` (free & premium) |
| 157 | +- 👉 Free [Support](https://appseed.us/support/) via Email & Discord |
0 commit comments