Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
app-generator authored Jun 22, 2023
0 parents commit 96b40f7
Show file tree
Hide file tree
Showing 308 changed files with 44,858 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
*.pyc
*.DS_Store
*.egg*
/dist/
/.idea
/docs/_build/
/node_modules/
build/
env
/staticfiles/

#src
*.sqlite*

.env
yarn.lock
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Change Log

## [1.0.5] 2023-06-05
### Changes

- Update DOCS (readme)
- [Django, HOT Reload in Docker](https://www.youtube.com/watch?v=o0hCE-EpoyA)
- YouTube Material

## [1.0.4] 2023-05-28
### Changes

- HOT Reload in Docker
- Django Code + Templates

## [1.0.3] 2023-05-22
### Changes

- Update Links (added product page)
- [Django Corporate](https://appseed.us/product/corporate-dashboard/django/)
- [Django Corporate PRO](https://appseed.us/product/corporate-dashboard-pro/django/)

## [1.0.2] 2023-05-20
### Changes

- Update `README`, added `PRO Version` links
- 🛒 [PRO Version](https://github.com/app-generator/django-corporate-dashboard-pro) - `GitHub Link`

## [1.0.1] 2023-05-19
### Changes

- Deploy [Django Corporate](https://django-corporate.onrender.com/) `LIVE Demo`

## [1.0.0] 2023-04-05
### Changes

- STABLE Version
- Design: [Django Admin Corporate](https://github.com/app-generator/django-admin-corporate) `v1.0.1`
22 changes: 22 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
FROM python:3.9

# set environment variables
ENV PYTHONDONTWRITEBYTECODE 1
ENV PYTHONUNBUFFERED 1

WORKDIR /app

COPY requirements.txt .
# install python dependencies
RUN pip install --upgrade pip
RUN pip install --no-cache-dir -r requirements.txt

COPY . .

RUN chmod +x /app/entrypoint.sh

# running migrations
RUN python manage.py migrate

# entrypoint
CMD ["bash", "-c", "/app/entrypoint.sh"]
32 changes: 32 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# MIT License

Copyright (c) 2019 - present [AppSeed](http://appseed.us/)

<br />

## Licensing Information

<br />

| Item | - |
| ---------------------------------- | --- |
| License Type | MIT |
| Use for print | **YES** |
| Create single personal website/app | **YES** |
| Create single website/app for client | **YES** |
| Create multiple website/apps for clients | **YES** |
| Create multiple SaaS applications | **YES** |
| End-product paying users | **YES** |
| Product sale | **YES** |
| Remove footer credits | **YES** |
| --- | --- |
| Remove copyright mentions from source code | NO |
| Production deployment assistance | NO |
| Create HTML/CSS template for sale | NO |
| Create Theme/Template for CMS for sale | NO |
| Separate sale of our UI Elements | NO |

<br />

---
For more information regarding licensing, please contact the AppSeed Service < *[email protected]* >
173 changes: 173 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
# [Django Corporate](https://appseed.us/product/corporate-dashboard/django/)

Open-source **Django** project crafted on top of **[Corporate Dashboard](https://appseed.us/product/corporate-dashboard/django/)**, an open-source `Bootstrap 5` design from [Creative-Tim](https://www.creative-tim.com/product/corporate-ui-dashboard?AFFILIATE=128200).
Designed for those who like bold elements and beautiful websites. Made of hundred of elements, designed blocks and fully coded pages, `Corporate Dashboard` is ready to help you create stunning websites and webapps.

- 👉 [Django Corporate](https://django-corporate.onrender.com/) - `LIVE Demo`
- 🛒 [Django Corporate PRO](https://appseed.us/product/corporate-dashboard-pro/django/) - `PRO Version`
- 🚀 Free [Support](https://appseed.us/support/) via Email & `Discord`

<br />

> Features:
-`Up-to-date Dependencies`
- ✅ Theme: [Django Admin Corporate](https://github.com/app-generator/django-admin-corporate), designed by [Creative-Tim](https://www.creative-tim.com/product/corporate-ui-dashboard?AFFILIATE=128200)
- `can be used in any Django project` (new or legacy)
-**Authentication**: `Django.contrib.AUTH`, Registration
- 🚀 `Deployment`
- `CI/CD` flow via `Render`
- [Django Soft - Go LIVE](https://www.youtube.com/watch?v=1QVdQVSkUCI) - `video presentation`

<br />

![Django Corporate Dashboard](https://user-images.githubusercontent.com/51070104/229719846-cfe96c5c-89c2-4ea0-89a9-7be69ebbb228.png)

<br />

## Start with `Docker`

> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/django-corporate-dashboard.git
$ cd django-corporate-dashboard
```

<br />

> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ chmod +x entrypoint.sh
$ docker-compose up --build
```

Visit `http://localhost:5085` in your browser. The app should be up & running.

<br />

## Manual Build

> 👉 Download the code
```bash
$ git clone https://github.com/app-generator/django-corporate-dashboard.git
$ cd django-corporate-dashboard
```

<br />

> 👉 Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```

<br />

> 👉 Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```

<br />

> 👉 Create the Superuser
```bash
$ python manage.py createsuperuser
```

<br />

> 👉 Start the app
```bash
$ python manage.py runserver
```

At this point, the app runs at `http://127.0.0.1:8000/`.

<br />

## Codebase structure

The project is coded using a simple and intuitive structure presented below:

```bash
< PROJECT ROOT >
|
|-- core/
| |-- settings.py # Project Configuration
| |-- urls.py # Project Routing
|
|-- home/
| |-- views.py # APP Views
| |-- urls.py # APP Routing
| |-- models.py # APP Models
| |-- tests.py # Tests
|
|-- templates/
| |-- includes/ # UI components
| |-- layouts/ # Masterpages
| |-- pages/ # Kit pages
|
|-- static/
| |-- css/ # CSS Files
| |-- scss/ # SCSS Files
| |-- corporate-ui-dashboard/_variables.scss # File Used for Theme Styling
|
|-- requirements.txt # Project Dependencies
|
|-- env.sample # ENV Configuration (default values)
|-- manage.py # Start the app - Django default start script
|
|-- ************************************************************************
```

<br />

## Recompile SCSS

The SCSS/CSS files used to style the Ui are saved in the `static` directory.
In order to update the Ui colors (primary, secondary) this procedure needs to be followed.

```bash
$ yarn # install modules
$ vi static/scss/corporate-ui-dashboard/_variables.scss # edit variables
$ gulp # SCSS to CSS translation
```

The `_variables.scss` content defines the `primary` and `secondary` colors:

```scss
$primary: #774dd3 !default; // EDIT for customization
$secondary: #64748b !default; // EDIT for customization
$info: #55a6f8 !default; // EDIT for customization
$success: #67c23a !default; // EDIT for customization
$warning: #f19937 !default; // EDIT for customization
$danger: #ea4e3d !default; // EDIT for customization
```

<br />

## Deploy on [Render](https://render.com/)

- Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click `New Blueprint Instance` button.
- Connect your `repo` which you want to deploy.
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
- After that your deployment will start automatically.

At this point, the product should be LIVE.

<br />

---
[Django Corporate](https://appseed.us/product/corporate-dashboard/django/) - **Django** starter provided by **[AppSeed](https://appseed.us/)**
24 changes: 24 additions & 0 deletions README_deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# How to deploy on `Render`

> This document should contains all the steps to deploy the app on render without much effort, using PostgreSQL
https://render.com/docs/deploy-django

## ALL STEPS below

<br />

### 👉 Create `PostgreSQL` database on render
- Go to https://dashboard.render.com/new/database this link.
- Database name should be `berry`.
- Keep the Database, User and Datadog API Key as it is.
- If you want to change database name anything else then you have to change your `render.yaml` file database name too.

<br />

### 👉 Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click `New Blueprint Instance` button.
- Connect your `repo` which you want to deploy.
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
- After that your deployment will start automatically.
10 changes: 10 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/usr/bin/env bash
# exit on error
set -o errexit

python -m pip install --upgrade pip

pip install -r requirements.txt

python manage.py collectstatic --no-input
python manage.py migrate
Empty file added core/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions core/asgi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
ASGI config for core project.
It exposes the ASGI callable as a module-level variable named ``application``.
For more information on this file, see
https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
"""

import os

from django.core.asgi import get_asgi_application

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")

application = get_asgi_application()
Loading

0 comments on commit 96b40f7

Please sign in to comment.