From 9a27f002324f112652967be58941fb8e74628e94 Mon Sep 17 00:00:00 2001 From: App Generator <51070104+app-generator@users.noreply.github.com> Date: Wed, 27 Nov 2024 17:35:49 +0200 Subject: [PATCH] v1.0.8 - Update RM Links --- CHANGELOG.md | 14 ++++ README.md | 207 +++++++---------------------------------------- README__.md | 203 ---------------------------------------------- README_deploy.md | 24 ------ 4 files changed, 42 insertions(+), 406 deletions(-) delete mode 100644 README__.md delete mode 100644 README_deploy.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e94487..8cec931 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Change Log +## [1.0.8] 2024-11-27 +### Changes + +> Update RM Links + +- 👉 [Django Atlantis Dark](https://app-generator.dev/product/atlantis-dark/django/) - `Product Page` +- 👉 [Django Atlantis Dark](https://app-generator.dev/docs/products/django/atlantis-dark/index.html) - `Complete Information` and Support Links + - [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial` + - `Configuration`: Install Dependencies, Prepare Environment, Setting up the Database + - `Start with Docker` + - `Manual Build` + - `Start the project` + - `Deploy on Render` + ## [1.0.7] 2023-10-24 ### Changes diff --git a/README.md b/README.md index 80a3b49..4988deb 100644 --- a/README.md +++ b/README.md @@ -1,200 +1,49 @@ -# [Atlantis Dark Django](https://appseed.us/product/atlantis-dark/django/) +# [Django Atlantis Dark](https://app-generator.dev/product/atlantis-dark/django/) -Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** generated by AppSeed op top of `Atlantis BS4 Design`, -an open-source admin template crafted by ThemeKita agency. It comes with the basic components and set of pre-built pages required to lay the foundation for any application. +Open-source **Django Dashboard** buit on top of `Atlantis Design`, an open-source admin template crafted by ThemeKita agency. +It comes with the basic components and set of pre-built pages required to lay the foundation for any application. -- 👉 [Atlantis Dark Django](https://appseed.us/product/atlantis-dark/django/) - `Product page` -- 👉 [Atlantis Dark Django](https://django-atlantis-dark.appseed-srv1.com/) - `LIVE Demo` +- 👉 [Django Atlantis Dark](https://app-generator.dev/product/atlantis-dark/django/) - `Product Page` +- 👉 [Django Atlantis Dark](https://django-atlantis-dark.appseed-srv1.com) - `LIVE Demo` +- 👉 [Django Atlantis Dark](https://app-generator.dev/docs/products/django/atlantis-dark/index.html) - `Complete Information` and Support Links + - [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial` + - `Configuration`: Install Dependencies, Prepare Environment, Setting up the Database + - `Start with Docker` + - `Manual Build` + - `Start the project` + - `Deploy on Render`
## Features -> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** +- Simple, Easy-to-Extend codebase +- `Atlantis Dark` Full Integration +- Bootstrap 4 Styling +- Session-based Authentication +- DB Persistence: SQLite +- Docker +- CI/CD integration for Render -| Free Version | [PRO Version](https://appseed.us/product/atlantis-dark-pro/django/) | [Custom Development](https://appseed.us/custom-development/) | -| --------------------------------------| --------------------------------------| --------------------------------------| -| ✓ **Django 4.1.12** | **Everything in Free**, plus: | **Everything in PRO**, plus: | -| ✓ Best Practices | ✅ **Premium Bootstrap Design** | ✅ **1 Week** `Custom Development` | -| ✓ Bootstrap Design | ✅ `Private REPO Access` | ✅ **Team**: PM, Developer, Tester | -| ✓ `Docker` | ✅ **[Premium Support](https://appseed.us/support/)** | ✅ Weekly Sprints | -| ✓ `CI/CD` Flow via Render | - |✅ Technical SPECS | -| ✓ `Free Support | - | ✅ Documentation | -| - | - | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** | -| ------------------------------------ | ------------------------------------ | ------------------------------------| -| ✓ [LIVE Demo](https://django-atlantis-dark.appseed-srv1.com/) | 🚀 [LIVE Demo](https://django-atlantis-dark-pro.appseed-srv1.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | - -![Atlantis Dark - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172799909-4cbc8eed-fdde-4408-ab61-123f235212d0.png) - -
- -## Start with `Docker` - -> 👉 **Step 1** - Download the code from the GH repository (using `GIT`) - -```bash -$ git clone https://github.com/app-generator/django-atlantis-dark.git -$ cd django-atlantis-dark -``` - -
- -> 👉 **Step 2** - Start the APP in `Docker` - -```bash -$ docker-compose up --build -``` - -Visit `http://localhost:5085` in your browser. The app should be up & running. - -
- -## Environment - -Create a new `.env` file using sample `env.sample`. The meaning of each variable can be found below: - -- `DEBUG`: if `True` the app runs in develoment mode - - For production value `False` should be used -- For `MySql` persistence - - Install the DB Driver: `pip install mysqlclient` - - Create DB and assign a new user (full rights) - - Edit `.env` to match the DB, user, password .. - -
- -## Manual Build - -> Download the code - -```bash -$ git clone https://github.com/app-generator/django-atlantis-dark.git -$ cd django-atlantis-dark -``` - -
- -### 👉 Set Up for `Unix`, `MacOS` - -> Install modules via `VENV` - -```bash -$ virtualenv env -$ source env/bin/activate -$ pip3 install -r requirements.txt -``` - -
- -> Set Up Database - -```bash -$ python manage.py makemigrations -$ python manage.py migrate -``` +![Atlantis Dark - Open-Source Template Django Template integrated with Django.](https://user-images.githubusercontent.com/51070104/172799909-4cbc8eed-fdde-4408-ab61-123f235212d0.png)
-> Start the APP - -```bash -$ python manage.py createsuperuser # create the admin -$ python manage.py runserver # start the project -``` - -At this point, the app runs at `http://127.0.0.1:8000/`. - -
- -### 👉 Set Up for `Windows` - -> Install modules via `VENV` (windows) - -``` -$ virtualenv env -$ .\env\Scripts\activate -$ pip3 install -r requirements.txt -``` - -
- -> Set Up Database - -```bash -$ python manage.py makemigrations -$ python manage.py migrate -``` - -
- -> Start the APP - -```bash -$ python manage.py createsuperuser # create the admin -$ python manage.py runserver # start the project -``` - -At this point, the app runs at `http://127.0.0.1:8000/`. - -
- -## 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 - | - |-- requirements.txt # Project Dependencies - | - |-- env.sample # ENV Configuration (default values) - |-- manage.py # Start the app - Django default start script - | - |-- ************************************************************************ -``` - -
- -## 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. - -
- -## [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/) - -This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design. `Volt Dashboard PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining. +## [Atlantis Dark PRO Version](https://app-generator.dev/product/atlantis-dark-pro/django/) -> Features: +> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-atlantis-dark-pro.appseed-srv1.com/). -- `Up-to-date Dependencies` -- `Design`: [Django Theme Volt](https://github.com/app-generator/django-volt-dashboard-pro) - `PRO Version` -- `Sections` covered by the design: +- **Simple, Easy-to-Extend** Codebase +- **Corporate Dashboard Design**, the PRO version. Section covered: - **Admin section** (reserved for superusers) - **Authentication**: `Django.contrib.AUTH`, Registration - **All Pages** available in for ordinary users -- `Docker`, `Deployment`: - - `CI/CD` flow via `Render` +- **Docker** +- **Deployment-Ready** for Render -![Volt Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172672843-8c40a801-3438-4e9c-86db-38a34191fbdf.png) +![Atlantis Dark PRO - Premium Template Django Template integrated with Django.](https://user-images.githubusercontent.com/51070104/212669274-3eef24b4-7c19-4557-99c5-e24ae5b14a5b.png)
--- -[Atlantis Dark Django](https://appseed.us/product/atlantis-dark/django/) - Open-source starter generated by **[AppSeed](https://appseed.us/)**. +[Django Atlantis Dark](https://app-generator.dev/product/atlantis-dark/django/) - Open-source starter generated by [App Generator](https://app-generator.dev) diff --git a/README__.md b/README__.md deleted file mode 100644 index 1d6644b..0000000 --- a/README__.md +++ /dev/null @@ -1,203 +0,0 @@ -# [Atlantis Dark Django](https://appseed.us/product/atlantis-dark/django/) - -Open-source **Django Dashboard** generated by `AppSeed` op top of a modern `Bootstrap` design. **[Atlantis Dark](https://appseed.us/product/atlantis-dark/django/)** is a free bootstrap 4 admin dashboard that is beautifully and elegantly designed to display various metrics, numbers or data visualization. Atlantis Lite admin dashboard has 2 layouts, many plugins and UI components to help developers create dashboards quickly and effectively so they can save development time and also help users to make the right and fast decisions based on existing data. - -- 👉 [Atlantis Dark Django](https://appseed.us/product/atlantis-dark/django/) - Product page -- 👉 [Atlantis Dark Django](https://django-atlantis-dark.appseed-srv1.com/) - LIVE Demo - -
- -> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-09-18 07:49` - -- `Up-to-date dependencies` -- Database: `sqlite` -- UI-Ready app, Django Native ORM -- `Session-Based authentication`, Forms validation - -
- -![Atlantis Dark - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172799909-4cbc8eed-fdde-4408-ab61-123f235212d0.png) - -
- -## ✨ Start the app in Docker - -> **Step 1** - Download the code from the GH repository (using `GIT`) - -```bash -$ git clone https://github.com/app-generator/django-atlantis-dark.git -$ cd django-atlantis-dark -``` - -
- -> **Step 2** - Start the APP in `Docker` - -```bash -$ docker-compose up --build -``` - -Visit `http://localhost:5085` in your browser. The app should be up & running. - -
- -## ✨ How to use it - -> Download the code - -```bash -$ git clone https://github.com/app-generator/django-atlantis-dark.git -$ cd django-atlantis-dark -``` - -
- -### 👉 Set Up for `Unix`, `MacOS` - -> Install modules via `VENV` - -```bash -$ virtualenv env -$ source env/bin/activate -$ pip3 install -r requirements.txt -``` - -
- -> Set Up Database - -```bash -$ python manage.py makemigrations -$ python manage.py migrate -``` - -
- -> Start the app - -```bash -$ python manage.py runserver -``` - -At this point, the app runs at `http://127.0.0.1:8000/`. - -
- -### 👉 Set Up for `Windows` - -> Install modules via `VENV` (windows) - -``` -$ virtualenv env -$ .\env\Scripts\activate -$ pip3 install -r requirements.txt -``` - -
- -> Set Up Database - -```bash -$ python manage.py makemigrations -$ python manage.py migrate -``` - -
- -> Start the app - -```bash -$ python manage.py runserver -``` - -At this point, the app runs at `http://127.0.0.1:8000/`. - -
- -## ✨ Create Users - -By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: - -- Start the app via `flask run` -- Access the `registration` page and create a new user: - - `http://127.0.0.1:8000/register/` -- Access the `sign in` page and authenticate - - `http://127.0.0.1:8000/login/` - -
- -## ✨ Code-base structure - -The project is coded using a simple and intuitive structure presented below: - -```bash -< PROJECT ROOT > - | - |-- core/ # Implements app configuration - | |-- settings.py # Defines Global Settings - | |-- wsgi.py # Start the app in production - | |-- urls.py # Define URLs served by all apps/nodes - | - |-- apps/ - | | - | |-- home/ # A simple app that serve HTML files - | | |-- views.py # Serve HTML pages for authenticated users - | | |-- urls.py # Define some super simple routes - | | - | |-- authentication/ # Handles auth routes (login and register) - | | |-- urls.py # Define authentication routes - | | |-- views.py # Handles login and registration - | | |-- forms.py # Define auth forms (login and register) - | | - | |-- static/ - | | |-- # CSS files, Javascripts files - | | - | |-- templates/ # Templates used to render pages - | |-- includes/ # HTML chunks and components - | | |-- navigation.html # Top menu component - | | |-- sidebar.html # Sidebar component - | | |-- footer.html # App Footer - | | |-- scripts.html # Scripts common to all pages - | | - | |-- layouts/ # Master pages - | | |-- base-fullscreen.html # Used by Authentication pages - | | |-- base.html # Used by common pages - | | - | |-- accounts/ # Authentication pages - | | |-- login.html # Login page - | | |-- register.html # Register page - | | - | |-- home/ # UI Kit Pages - | |-- index.html # Index page - | |-- 404-page.html # 404 page - | |-- *.html # All other pages - | - |-- requirements.txt # Development modules - SQLite storage - | - |-- .env # Inject Configuration via Environment - |-- manage.py # Start the app - Django default start script - | - |-- ************************************************************************ -``` - -
- - - -## PRO Version - -> For more components, pages and priority on support, feel free to take a look at this amazing starter: - -Black Dashboard is a premium Bootstrap Design now available for download in Django. Made of hundred of elements, designed blocks, and fully coded pages, Black Dashboard PRO is ready to help you create stunning websites and web apps. - -- 👉 [Atlantis Dark PRO Django](https://appseed.us/product/atlantis-dark-pro/django/) - Product Page -- 👉 [Atlantis Dark PRO Django](https://django-atlantis-dark-pro.appseed-srv1.com/) - LIVE Demo - -
- -![Atlantis Dark PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172800034-4d3adb79-d05e-430d-8ffe-f6860fc755f1.png) - -
- ---- -[Atlantis Dark Django](https://appseed.us/product/atlantis-dark/django/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**. diff --git a/README_deploy.md b/README_deploy.md deleted file mode 100644 index a1ac7e5..0000000 --- a/README_deploy.md +++ /dev/null @@ -1,24 +0,0 @@ -# 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 - -
- -### 👉 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. - -
- -### 👉 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. \ No newline at end of file