|
1 | | -# django-soft-argon-tailwind |
| 1 | +# Argon Dashboard Tailwind Django |
| 2 | + |
| 3 | +Open-source **Django Dashboard** generated by `AppSeed` op top of a modern design. Designed for those who like bold elements and beautiful websites, **Argon Dashboard** is ready to help you create stunning websites and webapps. **Argon Dashboard** is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining - Designed by [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200) |
| 4 | + |
| 5 | +- 👉 [Argon Dashboard Tailwind Django](#) - `product page` (coming soon) |
| 6 | +- 👉 [Argon Dashboard Tailwind Django](#) - `LIVE Demo` (coming soon) |
| 7 | + |
| 8 | +<br /> |
| 9 | + |
| 10 | +> Features |
| 11 | +
|
| 12 | +- ✅ Design: [Argon Dashboard](https://www.creative-tim.com/product/argon-dashboard-tailwind?AFFILIATE=128200) by `Creative-Tim` |
| 13 | +- ✅ Styling: `Tailwind CSS` |
| 14 | +- ✅ `Up-to-date dependencies` |
| 15 | +- ✅ `Session-Based authentication`, Forms validation |
| 16 | +- ✅ `Admin Section` Styled (reserved for superusers) |
| 17 | +- ✅ `Docker` |
| 18 | +- 🚀 `CI/CD` flow via `Render` |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +<br /> |
| 23 | + |
| 24 | +## Start with `Docker` |
| 25 | + |
| 26 | +> **Step 1** - Download the code from the GH repository (using `GIT`) |
| 27 | +
|
| 28 | +```bash |
| 29 | +$ git clone https://github.com/app-generator/django-argon-dashboard-tailwind.git |
| 30 | +$ cd django-argon-dashboard-tailwind |
| 31 | +``` |
| 32 | + |
| 33 | +<br /> |
| 34 | + |
| 35 | +> **Step 2** - Start the APP in `Docker` |
| 36 | +
|
| 37 | +```bash |
| 38 | +$ docker-compose up --build |
| 39 | +``` |
| 40 | + |
| 41 | +Visit `http://localhost:5085` in your browser. The app should be up & running. |
| 42 | + |
| 43 | +<br /> |
| 44 | + |
| 45 | +## Manual Build |
| 46 | + |
| 47 | +> Download the code |
| 48 | +
|
| 49 | +```bash |
| 50 | +$ git clone https://github.com/app-generator/django-argon-dashboard-tailwind.git |
| 51 | +$ cd django-argon-dashboard-tailwind |
| 52 | +``` |
| 53 | + |
| 54 | +<br /> |
| 55 | + |
| 56 | +### 👉 Set Up for `Unix`, `MacOS` |
| 57 | + |
| 58 | +> Install modules via `VENV` |
| 59 | +
|
| 60 | +```bash |
| 61 | +$ virtualenv env |
| 62 | +$ source env/bin/activate |
| 63 | +$ pip3 install -r requirements.txt |
| 64 | +``` |
| 65 | + |
| 66 | +<br /> |
| 67 | + |
| 68 | +> Set Up Database |
| 69 | +
|
| 70 | +```bash |
| 71 | +$ python manage.py makemigrations |
| 72 | +$ python manage.py migrate |
| 73 | +``` |
| 74 | + |
| 75 | +<br /> |
| 76 | + |
| 77 | +> Start the app |
| 78 | +
|
| 79 | +```bash |
| 80 | +$ python manage.py runserver |
| 81 | +``` |
| 82 | + |
| 83 | +At this point, the app runs at `http://127.0.0.1:8000/`. |
| 84 | + |
| 85 | +<br /> |
| 86 | + |
| 87 | +### 👉 Set Up for `Windows` |
| 88 | + |
| 89 | +> Install modules via `VENV` (windows) |
| 90 | +
|
| 91 | +``` |
| 92 | +$ virtualenv env |
| 93 | +$ .\env\Scripts\activate |
| 94 | +$ pip3 install -r requirements.txt |
| 95 | +``` |
| 96 | + |
| 97 | +<br /> |
| 98 | + |
| 99 | +> Set Up Database |
| 100 | +
|
| 101 | +```bash |
| 102 | +$ python manage.py makemigrations |
| 103 | +$ python manage.py migrate |
| 104 | +``` |
| 105 | + |
| 106 | +<br /> |
| 107 | + |
| 108 | +> Create Superuser |
| 109 | +
|
| 110 | +```bash |
| 111 | +$ python manage.py createsuperuser |
| 112 | +``` |
| 113 | + |
| 114 | +<br /> |
| 115 | + |
| 116 | +> Start the app |
| 117 | +
|
| 118 | +```bash |
| 119 | +$ python manage.py runserver |
| 120 | +``` |
| 121 | + |
| 122 | +At this point, the app runs at `http://127.0.0.1:8000/`. |
| 123 | + |
| 124 | +<br /> |
| 125 | + |
| 126 | +## Create Users |
| 127 | + |
| 128 | +By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: |
| 129 | + |
| 130 | +- Start the app via `flask run` |
| 131 | +- Access the `registration` page and create a new user: |
| 132 | + - `http://127.0.0.1:8000/register/` |
| 133 | +- Access the `sign in` page and authenticate |
| 134 | + - `http://127.0.0.1:8000/login/` |
| 135 | + |
| 136 | +<br /> |
| 137 | + |
| 138 | +## Codebase Structure |
| 139 | + |
| 140 | +The project is coded using a simple and intuitive structure presented below: |
| 141 | + |
| 142 | +```bash |
| 143 | +< PROJECT ROOT > |
| 144 | + | |
| 145 | + |-- core/ |
| 146 | + | |-- settings.py # Project Configuration |
| 147 | + | |-- urls.py # Project Routing |
| 148 | + | |
| 149 | + |-- home/ |
| 150 | + | |-- views.py # APP Views |
| 151 | + | |-- urls.py # APP Routing |
| 152 | + | |-- models.py # APP Models |
| 153 | + | |-- tests.py # Tests |
| 154 | + | |
| 155 | + |-- templates/ |
| 156 | + | |-- includes/ # HTML chunks and components |
| 157 | + | |
| 158 | + |-- static/ |
| 159 | + | |-- CSS, JS, Images # CSS files, Javascripts files |
| 160 | + | |
| 161 | + |-- requirements.txt # Project Dependencies |
| 162 | + | |
| 163 | + |-- env.sample # ENV Configuration (default values) |
| 164 | + |-- manage.py # Start the app - Django default start script |
| 165 | + | |
| 166 | + |-- ************************************************************************ |
| 167 | +``` |
| 168 | + |
| 169 | +<br /> |
| 170 | + |
| 171 | +## Customize CSS |
| 172 | + |
| 173 | +- Edit the `static/assets/scss/styles.css` |
| 174 | +- Regenerate the CSS using `NPM` or `Yarn` |
| 175 | + |
| 176 | +```bash |
| 177 | +$ npm i # Install modules |
| 178 | +$ npm run build # Recompile SCSS to CSS |
| 179 | +$ npm run min-css # Minify CSS |
| 180 | +$ // OR |
| 181 | +$ yarn # (via Yarn) Install modules |
| 182 | +$ yarn build # (via Yarn) Recompile SCSS to CSS |
| 183 | +$ yarn min-css # (via Yarn) Minify CSS |
| 184 | +``` |
| 185 | + |
| 186 | +<br /> |
| 187 | + |
| 188 | +--- |
| 189 | +Argon Dashboard Tailwind Django - Free starter provided by **[AppSeed](https://appseed.us/)**. |
0 commit comments