Skip to content

Commit b7a487a

Browse files
committed
Initial Codebase
1 parent ef8b727 commit b7a487a

File tree

156 files changed

+15045
-1
lines changed

Some content is hidden

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

156 files changed

+15045
-1
lines changed

.gitignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
*.pyc
2+
*.DS_Store
3+
*.egg*
4+
/dist/
5+
/.idea
6+
/docs/_build/
7+
/node_modules/
8+
build/
9+
env
10+
/staticfiles/
11+
12+
#src
13+
*.sqlite*
14+
15+
.env
16+
yarn.lock

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Change Log
2+
3+
## [0.0.1] 2023-03-13
4+
### Changes
5+
6+
- Create Codebase

Dockerfile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
FROM python:3.9
2+
3+
# set environment variables
4+
ENV PYTHONDONTWRITEBYTECODE 1
5+
ENV PYTHONUNBUFFERED 1
6+
7+
COPY requirements.txt .
8+
# install python dependencies
9+
RUN pip install --upgrade pip
10+
RUN pip install --no-cache-dir -r requirements.txt
11+
12+
COPY . .
13+
14+
# running migrations
15+
RUN python manage.py migrate
16+
17+
# gunicorn
18+
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"]

LICENSE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
<br />
10+
11+
| Item | - |
12+
| ---------------------------------- | --- |
13+
| License Type | MIT |
14+
| Use for print | **YES** |
15+
| Create single personal website/app | **YES** |
16+
| Create single website/app for client | **YES** |
17+
| Create multiple website/apps for clients | **YES** |
18+
| Create multiple SaaS applications | **YES** |
19+
| End-product paying users | **YES** |
20+
| Product sale | **YES** |
21+
| Remove footer credits | **YES** |
22+
| --- | --- |
23+
| Remove copyright mentions from source code | NO |
24+
| Production deployment assistance | NO |
25+
| Create HTML/CSS template for sale | NO |
26+
| Create Theme/Template for CMS for sale | NO |
27+
| Separate sale of our UI Elements | NO |
28+
29+
<br />
30+
31+
---
32+
For more information regarding licensing, please contact the AppSeed Service < *[email protected]* >

README.md

Lines changed: 189 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,189 @@
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+
![Argon Dashboard Tailwind Django](https://user-images.githubusercontent.com/51070104/224689600-e6cc9a64-88aa-471f-a52d-1d0a0a99e1c2.png)
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/)**.

README_deploy.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# How to deploy on `Render`
2+
3+
> This document should contains all the steps to deploy the app on render without much effort, using PostgreSQL
4+
5+
https://render.com/docs/deploy-django
6+
7+
## ALL STEPS below
8+
9+
<br />
10+
11+
### 👉 Create `PostgreSQL` database on render
12+
- Go to https://dashboard.render.com/new/database this link.
13+
- Database name should be `berry`.
14+
- Keep the Database, User and Datadog API Key as it is.
15+
- If you want to change database name anything else then you have to change your `render.yaml` file database name too.
16+
17+
<br />
18+
19+
### 👉 Create a Blueprint instance
20+
- Go to https://dashboard.render.com/blueprints this link.
21+
- Click `New Blueprint Instance` button.
22+
- Connect your `repo` which you want to deploy.
23+
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
24+
- After that your deployment will start automatically.

build.sh

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/usr/bin/env bash
2+
# exit on error
3+
set -o errexit
4+
5+
python -m pip install --upgrade pip
6+
7+
pip install -r requirements.txt
8+
9+
python manage.py collectstatic --no-input
10+
python manage.py migrate
11+
12+
# compile SCSS
13+
yarn
14+
yarn build
15+
yarn min-css

core/__init__.py

Whitespace-only changes.

core/asgi.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
ASGI config for core project.
3+
4+
It exposes the ASGI callable as a module-level variable named ``application``.
5+
6+
For more information on this file, see
7+
https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
8+
"""
9+
10+
import os
11+
12+
from django.core.asgi import get_asgi_application
13+
14+
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
15+
16+
application = get_asgi_application()

0 commit comments

Comments
 (0)