-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
db5a400
commit 884b4b3
Showing
1,979 changed files
with
59,889 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# True for development, False for production | ||
DEBUG=True | ||
|
||
# Deployment SERVER address | ||
SERVER=.appseed.us | ||
|
||
# Used for CDN (in production) | ||
# No Slash at the end | ||
ASSETS_ROOT=/static/assets |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
|
||
# tests and coverage | ||
*.pytest_cache | ||
.coverage | ||
|
||
# database & logs | ||
*.db | ||
*.sqlite3 | ||
*.log | ||
|
||
# venv | ||
env | ||
venv | ||
|
||
# other | ||
.DS_Store | ||
|
||
# javascript | ||
package-lock.json | ||
|
||
staticfiles/* | ||
!staticfiles/.gitkeep | ||
.vscode/symbols.json | ||
|
||
apps/static/assets/node_modules | ||
apps/static/assets/yarn.lock | ||
apps/static/assets/.temp | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
FROM python:3.9 | ||
|
||
# set environment variables | ||
ENV PYTHONDONTWRITEBYTECODE 1 | ||
ENV PYTHONUNBUFFERED 1 | ||
|
||
COPY requirements.txt . | ||
# install python dependencies | ||
RUN pip install --upgrade pip | ||
RUN pip install --no-cache-dir -r requirements.txt | ||
|
||
COPY . . | ||
|
||
# running migrations | ||
RUN python manage.py migrate | ||
|
||
# gunicorn | ||
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 < *support@appseed.us* > |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,235 @@ | ||
# [Pixel Lite](https://appseed.us/generator/pixel-bootstrap/) Django | ||
|
||
`Open-Source` seed project generated by AppSeed in **Django** Framework on top of **[Pixel Lite](https://appseed.us/generator/pixel-bootstrap/)** design. `Pixel` is a free and open-source `Bootstrap 5` based UI Kit featuring over 80 fully coded UI elements and example pages that will help you prototype and build a website for your next project. | ||
|
||
- 👉 [Django Pixel Lite](https://appseed.us/product/pixel-bootstrap/django/) - product page | ||
- 👉 [Django Pixel Lite](https://django-pixel-lite.appseed-srv1.com/) - LIVE Deployment | ||
|
||
<br /> | ||
|
||
> Built with [Pixel Lite Generator](https://appseed.us/generator/pixel-bootstrap/) | ||
- Timestamp: `2022-05-31 08:05` | ||
- Build ID: `36776f20-0a35-4449-8714-a649a342a8d3` | ||
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord` | ||
|
||
<br /> | ||
|
||
> Features | ||
- `Up-to-date dependencies` | ||
- Database: `sqlite` | ||
- UI-Ready app, Django Native ORM | ||
- `Session-Based authentication`, Forms validation | ||
|
||
<br /> | ||
|
||
![Pixel Bootstrap Lite - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168753915-d61b2f97-57b2-4d14-a774-d217d120ff62.png) | ||
|
||
<br /> | ||
|
||
|
||
## ✨ Start the app in Docker | ||
|
||
> **Step 1** - Download the code from the GH repository (using `GIT`) | ||
```bash | ||
$ # Get the code | ||
$ git clone https://github.com/app-generator/django-pixel.git | ||
$ cd django-pixel | ||
``` | ||
|
||
<br /> | ||
|
||
> **Step 2** - Edit `.env` and remove or comment all `DB_*` settings (`DB_ENGINE=...`). This will activate the `SQLite` persistance. | ||
```txt | ||
DEBUG=True | ||
# Deployment SERVER address | ||
SERVER=.appseed.us | ||
# For MySql Persistence | ||
# DB_ENGINE=mysql <-- REMOVE or comment for Docker | ||
# DB_NAME=appseed_db <-- REMOVE or comment for Docker | ||
# DB_HOST=localhost <-- REMOVE or comment for Docker | ||
# DB_PORT=3306 <-- REMOVE or comment for Docker | ||
# DB_USERNAME=appseed_db_usr <-- REMOVE or comment for Docker | ||
# DB_PASS=<STRONG_PASS> <-- REMOVE or comment for Docker | ||
``` | ||
|
||
<br /> | ||
|
||
> **Step 3** - Start the APP in `Docker` | ||
```bash | ||
$ docker-compose up --build | ||
``` | ||
|
||
Visit `http://localhost:5085` in your browser. The app should be up & running. | ||
|
||
<br /> | ||
|
||
|
||
|
||
|
||
## ✨ How to use it | ||
|
||
> Download the code | ||
```bash | ||
$ # Get the code | ||
$ git clone https://github.com/app-generator/django-pixel.git | ||
$ cd django-pixel | ||
``` | ||
|
||
<br /> | ||
|
||
### 👉 Set Up for `Unix`, `MacOS` | ||
|
||
> Install modules via `VENV` | ||
```bash | ||
$ virtualenv env | ||
$ source env/bin/activate | ||
$ pip3 install -r requirements.txt | ||
``` | ||
|
||
<br /> | ||
|
||
> Set Up Database | ||
```bash | ||
$ python manage.py makemigrations | ||
$ python manage.py migrate | ||
``` | ||
|
||
<br /> | ||
|
||
> Start the app | ||
```bash | ||
$ python manage.py runserver | ||
``` | ||
|
||
At this point, the app runs at `http://127.0.0.1:8000/`. | ||
|
||
<br /> | ||
|
||
### 👉 Set Up for `Windows` | ||
|
||
> Install modules via `VENV` (windows) | ||
``` | ||
$ virtualenv env | ||
$ .\env\Scripts\activate | ||
$ pip3 install -r requirements.txt | ||
``` | ||
|
||
<br /> | ||
|
||
> Set Up Database | ||
```bash | ||
$ python manage.py makemigrations | ||
$ python manage.py migrate | ||
``` | ||
|
||
<br /> | ||
|
||
> Start the app | ||
```bash | ||
$ python manage.py runserver | ||
``` | ||
|
||
At this point, the app runs at `http://127.0.0.1:8000/`. | ||
|
||
<br /> | ||
|
||
## ✨ 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/` | ||
|
||
<br /> | ||
|
||
## ✨ 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, JS, images> # 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 | ||
| | ||
|-- ************************************************************************ | ||
``` | ||
|
||
<br /> | ||
|
||
## ✨ PRO Version | ||
|
||
> For more components, pages and priority on support, feel free to take a look at this amazing starter: | ||
**Pixel PRO** is a premium design crafted by the `Themesberg` agency on top of Bootstrap 5 Framework. **Pixel** is a premium `Bootstrap 5 UI Kit` that provides 1000+ components, 50+ sections and 35 example pages including a fully fledged user dashboard. | ||
|
||
- 👉 [Django Pixel PRO](https://appseed.us/product/pixel-bootstrap-pro/django/) - product page | ||
- 👉 [Django Pixel PRO](https://django-pixel-pro.appseed-srv1.com/) - LIVE Demo | ||
|
||
<br > | ||
|
||
![Pixel Bootstrap PRO - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168760719-f0e45406-2b2a-43e0-badf-fa953edb62b8.png) | ||
|
||
<br /> | ||
|
||
--- | ||
[Pixel Lite](https://appseed.us/generator/pixel-bootstrap/) Django - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.contrib import admin | ||
|
||
# Register your models here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.apps import AppConfig | ||
|
||
|
||
class AuthConfig(AppConfig): | ||
name = 'apps.auth' | ||
label = 'apps_auth' |
Oops, something went wrong.