Skip to content

Latest commit

 

History

History
87 lines (72 loc) · 2.85 KB

README.md

File metadata and controls

87 lines (72 loc) · 2.85 KB
Raw

SPC Portal Build codecov Django 2.0.5 Python 3.6

A portal for handling Student Placements

Purpose

A portal for handling Student Placements

Building: Quick start with Visual Studio Code Remote - Containers

This helps you pull and build quickly - dev containers launch the project inside a container with all the tooling required for a consistent and seamless developer experience.

This means you don't have to install and configure your dev environment as the container handles this for you.

To get started install VSCode and the Remote Containers extensions

Clone the repo and launch code:

git clone https://github.com/anshulahuja98/spc_portal/
cd spc_portal
code .

Once VSCode launches run CTRL+SHIFT+P -> Remote-Containers: Reopen in container and then use the integrated terminal to run:

  • Make database migrations 
    python3 manage.py makemigrations student
python3 manage.py migrate student
python3 manage.py makemigrations
python3 manage.py migrate
  • Create a superuser 
    python manage.py createsuperuser
  • Run development server on localhost 
    python manage.py runserver

Note: The first time you run the container it will take some time to build and install the tooling. The image will be cached so this is only required the first time.

Building: Locally directly

Installation:

Requirements:

  • Python 3.6 runtime
  • Django 2.0.5
  • Other dependencies in requirements.txt

Procedure:

  • Install python in your environment(pre-installed on Ubuntu).
  • Navigate to the cloned repository. 
    cd <project_directory_name>     #   spc_portal
  • Create a new virtual environment and activate it. 
    sudo apt-get install -y python3-venv
python3 -m venv spc_portal_venv
source spc_portal_venv/bin/activate
  • Use pip to install other dependencies from requirements.txt 
    pip install -r requirements.txt
  • Copy .env file 
    cp .env.example .env
  • Make database migrations 
    python3 manage.py makemigrations student
python3 manage.py migrate student
python3 manage.py makemigrations
python3 manage.py migrate
  • Create a superuser 
    python manage.py createsuperuser
  • Run development server on localhost 
    python manage.py runserver