Skip to content

brennanbrown/django-project

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Brennan's Django Showcase

GitHub code size in bytes GitHub repo size GitHub top language GitHub issues GitHub last commit GitHub Website
GitHub followers GitHub watchers GitHub stars GitHub forks

Table of Contents:

About The Project

View project here!

Django—an open-source web framework that's designed on top of Python—can help you quickly bring your website ideas to life. This project utilizes Bootstrap 4 and vanilla JavaScript for the front-end, and a PostgresSQL database, with GraphQL used for API functionality. It also uses Selenium for test-driven development. Finally, this is will be deployed on a DigitalOcean Droplet under their smallest plan, so I apologize for any issues regarding speed or connectivity!

For more information about specific areas of this project, please refer to my personal notes.

Getting Started

For development, you will need Python 3.6 or higher, pip, venv, and PostgeSQL installed in your environment.

Prerequisites

  • A good understanding of web development (HTML, CSS, JavaScript)
  • Basic knowledge of Python and SQL database systems
  • Familar with Django framework for front-end and back-end development
  • Object-oriented Programming (OOP) paradigm
  • Model-View-Controller (MVC) paradigm
  • Model-View-ViewMode (MVVM) paradigm
  • Knowledge and use of the Command-line Interface (CLI)

Python installation on Ubuntu

On Ubuntu 20.04 and later, Python 3 comes pre-installed. Check first to see if you have the tools required already installed:

$ python3 --version
$ pip3 --version

Head over to the official Python website and download the installer Also, be sure to have git donwloaded and available in your PATH as well.

You can install Python and pip easily with apt install, just run the following commands:

$ sudo apt install python3
$ sudo apt install python3-pip

There are a few more packages and development tools to install to ensure that we have a robust setup for our programming environment:

$ sudo apt install -y build-essential libssl-dev libffi-dev python3-dev

If you need to update pip, you can make it using pip! Cool right? After running the following command, just open again the command line and be happy.

$ python3 -m pip install --upgrade pip

PostgreSQL installation on Ubuntu

Installation of PostgreSQL via CLI:

# Create the file repository configuration:
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'

# Import the repository signing key:
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -

# Update the package lists:
sudo apt-get update

# Install the latest version of PostgreSQL.
# If you want a specific version, use 'postgresql-12' or similar instead of 'postgresql':
sudo apt-get install postgresql

Installation of the pgAdmin GUI:

$ wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc |
sudo apt-key add -
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/
`lsb_release -cs`-pgdg main" >> /etc/apt/sources.list.d/pgdg.list'
$ sudo apt-get update
$ sudo apt-get install pgadmin4 pgadmin4-apache2 -y

Please note for sake of ease, this project is set to work with the default configurations of PostgreSQL on a local installation.

Installation

$ git clone https://github.com/brennanbrown/django-project.git
$ cd django-project

Virtual Environment (venv)

While there are a few ways to achieve a programming environment in Python, we’ll be using the venv module here, which is part of the standard Python 3 library. Let’s install venv by typing:

$ sudo apt install python3-venv

Creating and entering a new virtual environment:

$ python3 -m venv env
$ . env/bin/activate
$ pip install -r requirements.txt

You can ensure that you're in your new virutal Environment if you see (env) prepend your bash shell:

(env) user@ubuntu:~/django_project$ 

Running the project

$ python3 manage.py runserver

Once the server has started up, you can visit it at localhost:8000/, or 127.0.0.1:8000/.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Brennan K. Brown - @brennankbrown - mail@brennanbrown.ca

Project Link: https://github.com/brennanbrown/django-project

About

A full-stack Django project, with a PostgreSQL database, using Selenium for tests, and deployed in real-time. Under construction.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published