Git Product home page Git Product logo

portfolio-web's Introduction

Portfolio Website

Website Build Status License

Portfolio website that showcases projects, work experiences and education history using Django. Contents are customizable through the admin site. (The old site can be found here)

Prerequisites

Installing

First, clone the repository to the machine, then active the python virtual environment

git clone https://github.com/jiachengzhang1/portfolio-web.git
source path/to/active/file/active/

Go into the repository directory, install required packages

cd /path/to/the/repository/
pip install -r requirements.txt

The application uses SQLite in development and PostgreSQL in production. Django automatically creates a SQLite database for the application, so no extra settings required for development. Use manage.py to migrate.

python manage.py makemigrations
python manage.py migrate

Create a superuser, follow the prompts to set up the credential which is used for admin login.

python manage.py createsuperuser

To start the application,

python manage.py runserver

Now, the application is running on the localhost port 8000 http://127.0.0.1:8000. You can create the contents through the admin page http://127.0.0.1:8000/admin.

Deploy on Ubuntu Server

DigitialOcean has very good instructions on deploying Django application with Postgres, Nginx, and Gunicorn.

In addition, compile SCSS files before run collectstatic,

python manage.py compilescss
python manage.py collectstatic

Learn more about django-sass-processor through their GitHub repository

Built With

  • Django - The web application framework used
  • django-sass-processor - Compile SASS/SCSS files on the fly
  • PostgreSQL - The database used by the application (producation)
  • SQLite - The database used by the application (development)

Authors

Jiacheng Zhang

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

The design of the website is inspired by jtom.me and andrewborstein.com

portfolio-web's People

Stargazers

 avatar

Watchers

 avatar  avatar

portfolio-web's Issues

Add Documentation

A documentation summarizes the website, describes the technologies used, and briefs the deployment

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.