hanjustin / poll-web

Basic REST API built to gain familiarity of Django

Highlights

Key functionalities:	RESTful web service + CI
Tech used:	Python, Django, PostgreSQL, Docker, Jenkins

CI workflow diagram link

Getting Started

1. Clone the repo

git clone https://github.com/hanjustin/Poll-Web.git

2. Start Jenkins CI & Postgres

docker compose up

3. Create database tables

python manage.py migrate

4. Run

python manage.py runserver

5. Use the webservice XXXX

curl -XGET -H "Content-type: application/json" -d '{"name": "Justin", "username": "hanjustin"}' 'http://localhost:8080/api/users/'

Running Jenkins and Postgres separately

docker compose up runs both Jenkins Postgres together. To run them separately, use the commands below:

Jenkins

1. Build Jenkins image

docker build -t jenkinsimage .

2. Run the image in Docker

docker run --name jenkins -p 8080:8080 --env JENKINS_ADMIN_ID=admin --env JENKINS_ADMIN_PASSWORD=password jenkinsimage

Postgres

docker run --name postgres-test -e POSTGRES_DB=djangoPostgreSQL -e POSTGRES_USER=mydatabaseuser -e POSTGRES_PASSWORD=mypassword -p 5433:5432 postgres