https://github.com/usd-cs/comp-49x-24-25-smse-intro-project

https://github.com/usd-cs/comp-49x-24-25-smse-intro-project

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/usd-cs/comp-49x-24-25-smse-intro-project
• Owner: usd-cs
• Created: 2024-10-31T22:00:57.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T04:38:42.000Z (about 2 months ago)
• Last Synced: 2024-11-20T05:25:51.513Z (about 2 months ago)
• Language: Python
• Size: 72.3 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SMSE Team Intro Project

Description: The SMSE Intro Project is a web-based blog application that allows users to create posts, comment on existing posts, and engage in discussions. The project aims to provide a simple, user-friendly platform where authenticated users can participate in content creation while ensuring that administrative controls are maintained for content moderation. 

Table of Contents:

  1. Features

  2. Requirments

  3. Install Dependencies:

  4. Database Setup

  5. Run Migrations

  6. Run Development Server

  7. Testing:

  8. Load Test Data

  9. URLs

  10. Test Users usernames and passwords

  11. UI Design

Features:

Requirements:

  - Python (version 3.10 or higher)

  - PostgreSQL (latest version)

  - pip

Setup:

  1. Clone Repository

  2. cd intro_project

Install Dependencies:

  - pip install -r requirements.txt (installs Django, psycopg2, and other required Python packages)

Database Setup:

  1. bash# psql -U postgres (login to postgresql, i used username:postgres and password: password)

  2. sql# CREATE DATABASE intro_project_db;

  3. sql# CREATE USER postgres WITH PASSWORD password; (this is the username and password we're all using)

  4. sql# GRANT ALL PRIVILEGES ON DATABASE intro_project_db TO postgres;

        The database settings under settings.py should look like this:

        DATABASES = {

          'default': {

              'ENGINE': 'django.db.backends.postgresql',

              'NAME': 'intro_project_db',

              'USER': 'postgres',

              'PASSWORD': 'password',

              'HOST': 'localhost',

              'PORT': '5432',

          }

        }

Run Migrations:

  5. bash# python manage.py makemigrations (then make sure to set up the database model objects )

  6. bash# python manage.py migrate

  7. python manage.py createsuperuser (made a superuser)

       - username: admin

       - email address: [email protected]

       - password: password

Run Development Server:

  8. python manage.py runserver  (runs the app)

Testing:

  python manage.py test  (runs the tests)

Load Test Data:

  - Make sure PostgreSql is running

  - python manage.py loaddata fixtures/test_data.json

  - The test data is called test_data.json and is under posts/fixtures

  - check the admin page to make sure all the users and their posts are there.

URLs

  (http://127.0.0.1:8000/admin/)        directs to the django admin panel

  (http://127.0.0.1:8000/posts/)       shows a list of all posts

  /posts/create_post/  should create a new post but not working right now (or need to login first)

  /login/         should redirect for non logged in users but not working right now

Test Users

  - username: user1

  - email: [email protected]

  - password: user1password

  - username: admin

  - email: [email protected]

  - password: adminpassword

UI Design

  - Figma UI design for the project: https://www.figma.com/design/YVS33HH5t2CeZHXbrviOy6/SMSE-Intro-Project-Design?node-id=2304-963&t=B59YOP0OfzPS1Udq-1