Rocket Django • TailwindCSS • Flowbite • OpenAI • API (DRF) • Celery • Redis • DataTables • Charts • Docker • CI/CD
This website brings an innovative solution to the Ambrose Treacy College fishing club. This website utilizes government APIs to allow members to easily identify what they caught. Furthermore, social features introduce a new way for club members to interact.
👉 Download code
git clone https://github.com/NathanPerrier/IA3-Perrier-Fishing-Website-Digital
cd IA3-Perrier-Fishing-Website-Digital👉 Create
.envfromenv.sample
DEBUG=False
SECRET_KEY=<STRONG_KEY_HERE>
# For Myql or PgSQL Persistence
# DB_ENGINE=mysql
# DB_HOST=localhost
# DB_NAME=appseed_rocket_django
# DB_USERNAME=root
# DB_PASS=
# DB_PORT=3306
#SMTP configaration
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
EMAIL_USE_TLS=True
EMAIL_HOST_USER=<HOST_EMAIL>
EMAIL_HOST_PASSWORD=<HOST_PASSWORD>
GOOGLE_OAUTH2_CLIENT_ID=<CLIENT_ID>
GOOGLE_OAUTH2_CLIENT_SECRET=<CLIENT_SECRET>
GITHUB_OAUTH2_CLIENT_ID=<CLIENT_ID>
GITHUB_OAUTH2_CLIENT_SECRET=<CLIENT_SECRET>
MICROSOFT_OAUTH2_APP_ID=<CLIENT_ID>
MICROSOFT_OAUTH2_CLIENT_SECRET=<CLIENT_SECRET>
MICROSOFT_OAUTH2_TENANT_ID=<TENANT_ID>
#ReCaptcha
RECAPTCHA_SITE_KEY=<PUBLIC_KEY>
RECAPTCHA_V3_SITE_KEY=<PUBLIC_KEY>
RECAPTCHA_SECRET_KEY=<PRIVATE_KEY>👉 Unrestrict current user scope
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;👉 Install Django modules via
VENV
virtualenv env
.\venv\Scripts\activate
pip install -r requirements.txt👉 Install Tailwind/Flowbite (another terminal)
Tested with Node v18.20.0 (use at least this version or above)
npm install
npm run dev
npx tailwindcss -i ./static/assets/style.css -o ./static/dist/css/output.css --watch # DEVELOPMENT (LIVE reload)
npx tailwindcss -i ./static/assets/style.css -o ./static/dist/css/output.css # PRODUCTION👉 Migrate DB
python manage.py makemigrations
python manage.py migrate👉 Update the database with wildlife data (may take 10-15 minutes)
python manage.py update_wildlife --fish-only --debug👉 Run celery worker
celery -A core worker --loglevel=info -E👉 Create
Superuser
python manage.py createsuperuser # create the admin👉 run the website
Normal **runserver** (http)
python manage.py runserver 👉 Download code
git clone https://github.com/NathanPerrier/IA3-Perrier-Fishing-Website-Digital
cd IA3-Perrier-Fishing-Website-Digital👉 Start with Docker Compose
docker-compose up --build Visit the app in the browser localhost:5085.
By default, the starter uses SQLite for persistence. In order to use MySql, here are the steps:
- Start the MySql Server
- Create a new DataBase
- Create a new user with full privileges over the database
- Install the MySql Python Driver (used by Django to connect)
pip install mysqlclient
- Edit the
.envwith the SQL Driver Information & DB Credentials
DB_ENGINE=mysql
DB_HOST=localhost
DB_NAME=<DB_NAME_HERE>
DB_USERNAME=<DB_USER_HERE>
DB_PASS=<DB_PASS_HERE>
DB_PORT=3306
Once the above settings are done, run the migration & create tables:
python manage.py makemigrations
python manage.py migrateTo use the starter in production mode, here are the steps:
- Set DEBUG=False in
.env - Execute
collectstaticcommandpython manage.py collectstatic --no-input
As a model, feel free to take a look at build.sh, the file executed by the CI/CD flow for Render:
- Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click
New Blueprint Instancebutton. - Connect the
repothat you want to deploy. - Fill the
Service Group Nameand click on theUpdate Existing Resourcesbutton. - Edit the Environment and specify the PYTHON_VERSION
- Version
3.11.5was used for this deployment
- Version
- After that, your deployment will start automatically.
At this point, the product should be LIVE.
< PROJECT ROOT >
|
|-- core/ # Project Settings
| |-- settings.py
| |-- wsgi.py
| |-- urls.py
|
|-- home/ # Presentation app
| |-- views.py # serve the HOMEpage
| |-- urls.py
| |-- models.py
|
|-- apps/ # Utility Apps
| |-- common/ # defines models & helpers
| | |-- models.py
| | |-- util.py
| |-- users # Handles Authentication
| |-- api # DRF managed API
| |-- auth_tokens # Manages User API tokens
| |-- club # Implements club signup
| |-- microsoft_auth # Oauth2.0 manaement for microsoft (PYPI library)
| |-- social # all social aspects of the website (posts, likes, etc.)
| |-- tracking # tracking and suggestions
| |-- wildlifeAPI # retrieves and stores data from QLD wildlifeNet API
| |-- tasks # Celery, async processing
|
|-- templates/ # UI templates
|-- static/ # Tailwind/Flowbite
| |-- src/ #
| |-- input.css # CSS Styling
|
|-- Dockerfile # Docker
|-- docker-compose.yml # Docker
|
|-- render.yml # CI/CD for Render
|-- build.sh # CI/CD for Render
|
|-- manage.py # Django Entry-Point
|-- requirements.txt # dependencies
|-- .env # ENV File
|
|-- ************************************************* @MIT
Built on the Rocket Django repository - styled with Tailwind/Flowbite