Portfolio Website

This is a portfolio website built using Django 4, Django REST Framework 3, Next.js 13, and Material UI 5. The app uses a PostgreSQL database to store data.

Dark mode:

Light mode:

Table of Contents

• Prerequisites
• Installation
• Running the application
• Running the tests
• Adding data to the application
• Customizing the application
• Copyright and License

Prerequisites

Install the following prerequisites:

1. Python 3.8-3.11
   This project uses Django v4.2.4. For Django to work, you must install a correct version of Python on your machine. More information here.
2. Node.js
3. PostgreSQL
4. Visual Studio Code

Installation

Backend

1. Create a virtual environment

From the root directory, run:

cd backend

python -m venv venv

2. Activate the virtual environment

From the backend directory, run:

On macOS:

source venv/bin/activate

On Windows:

venv\scripts\activate

3. Install required backend dependencies

From the backend directory, run:

pip install -r requirements.txt

4. Set up a PostgreSQL database

With PostgreSQL up and running, in a new Terminal window, run:

dropdb --if-exists portfolio

Start psql, which is a terminal-based front-end to PostgreSQL, by running the command:

psql postgres

Create a new PostgreSQL database:

CREATE DATABASE portfolio;

Create a new database admin user:

CREATE USER yourusername WITH SUPERUSER PASSWORD 'yourpassword';

To quit psql, run:

\q

5. Set up backend environment variables

From the backend directory, run:

touch config/.env

The touch command will create the .env file in the backend/config directory. This command works on Mac and Linux but not on Windows. If you are a Windows user, instead of using the command line, you can create the .env file manually by navigating in Visual Studio Code to the Explorer, clicking on the config directory (inside the backend directory), and selecting the option New File.

Next, declare environment variables in the .env file. Make sure you don't use quotation marks around the strings.

SECRET_KEY=yoursecretkey
DATABASE_NAME=portfolio
DATABASE_USER=yourusername
DATABASE_PASS=yourpassword
DATABASE_HOST=localhost
FRONTEND_URL=http://localhost:3000

6. Run migrations

From the backend directory, run:

python manage.py makemigrations

python manage.py migrate

7. Create an admin user to access the Django Admin interface

From the backend directory, run:

python manage.py createsuperuser

When prompted, enter a username, email, and password.

Frontend

1. Install required frontend dependencies

From the root directory, run:

cd frontend

npm install

2. Set up frontend environment variables

From the frontend directory, run:

touch .env.development && touch .env.production

The touch command will create the .env.development and .env.production files in the frontend directory. This command works on Mac and Linux but not on Windows. If you are a Windows user, instead of using the command line, you can create the .env.development and .env.production files manually by navigating in Visual Studio Code to the Explorer, clicking on the frontend directory, and selecting the option New File.

Next, declare environment variables in the .env.development file. Make sure you don't use quotation marks around the strings.

BACKEND_HOST=127.0.0.1
BACKEND_URL=http://127.0.0.1:8000

Run the application

To run the application, you need to have both the backend and the frontend up and running.

1. Run backend

From the backend directory, run:

python manage.py runserver

2. Run frontend

From the frontend directory, run:

npm run dev

3. View the application

Go to http://localhost:3000/ to view the application.

Run the tests

1. Run the backend tests

From the backend directory, run:

python manage.py test --pattern="tests.py"

2. Run the frontend tests

From the frontend directory, run:

npm run test

Add data to the application

Add data through Django Admin.

Go to http://127.0.0.1:8000/admin to access the Django Admin interface and sign in using the admin credentials.

Customize the application

This section describes how to customize the application.

Changing Section Titles and Subtitles

1. About

To modify the title and subtitle of the About section, make changes in the frontend/src/components/About.js file.

2. Projects

To modify the title and subtitle of the Projects section, make changes in the frontend/src/components/Projects.js file.

3. Technologies

To modify the title and subtitle of the Technologies section, make changes in the frontend/src/components/Technologies.js file.

4. Contact

To modify the title and subtitle of the Contact section, make changes in the frontend/src/components/Contact.js file.

Changing Colors

To modify the colors in the application, make changes in the frontend/src/theme/theme.js file.

Changing Fonts

To modify the fonts in the application, first, add a new font to the frontend/src/pages/_document.js file, and then make changes in the frontend/src/theme/typography.js file.

Changing Logo

To modify the logo in the application, make changes in the frontend/src/layout/Header.js and frontend/src/layout/Sidebar.js files.

Changing Buttons in the Hero Section

To modify the two buttons in the Hero section, make changes in the frontend/src/components/HeroButtons.js file.

Copyright and License

Copyright © 2022 Bob's Programming Academy. Code released under the MIT license.