{"id":25729530,"url":"https://github.com/8bituhm/8bit-site","last_synced_at":"2025-05-07T13:42:47.377Z","repository":{"id":255607367,"uuid":"784014004","full_name":"8bitUHM/8bit-site","owner":"8bitUHM","description":"Official website of 8bit UHM.","archived":false,"fork":false,"pushed_at":"2025-02-24T03:08:45.000Z","size":22998,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-25T10:41:57.880Z","etag":null,"topics":["bootstrap","django","postgresql","python","react","typescript","webpack"],"latest_commit_sha":null,"homepage":"https://8bithawaii.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/8bitUHM.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-09T02:32:26.000Z","updated_at":"2025-02-24T03:08:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"85a63f29-0189-46ad-b0fd-2b02f4788b9d","html_url":"https://github.com/8bitUHM/8bit-site","commit_stats":null,"previous_names":["8bituhm/8bit-site"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8bitUHM%2F8bit-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8bitUHM%2F8bit-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8bitUHM%2F8bit-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8bitUHM%2F8bit-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/8bitUHM","download_url":"https://codeload.github.com/8bitUHM/8bit-site/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240777572,"owners_count":19855856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","django","postgresql","python","react","typescript","webpack"],"created_at":"2025-02-26T01:38:18.762Z","updated_at":"2025-02-26T01:38:20.042Z","avatar_url":"https://github.com/8bitUHM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 8bit Website\n\nDjango 4.2.8 with Supabase PostgreSQL database and Django Rest Framework\n\n1. [Project Structure](#project-structure)\n2. [Getting the app running](#getting-the-app-running)\n3. [Development](#development)\n\n## Project Structure\n\nThe project is organized into several components:\n\n- **8bit-site**: The main Django project directory.\n\n  - **db_file_storage/**: File storage systems that allows us to store files by raw bytes and mimetype in database.\n\n  - **vercel_app/**: Main or 'host' app\n    - **settings.py**: Configuration settings for the project, including database settings, middleware, installed apps, and other project-specific configurations. Models are defined here.\n    - **urls.py**: URL configuration for the project, mapping URLs to views.\n  - **main_app/**: main app\n    - **frontend/**: Folder that holds react project src files\n    - **migrations/**: Database migration files.\n    - **static/**: Static files (CSS, JavaScript, images).\n    - **templates/**: HTML templates.\n    - **admin.py**: Admin interface configuration.\n    - **forms.py**: HTML forms. Forms define how data is input and validated by the user.\n    - **models.py**: Data models. Models define the structure of the database and interact with data.\n    - **serializers.py**: Serializers for converting complex data types, such as querysets and model instances, to native Python datatypes that can then be easily rendered into JSON, XML, or other content types.\n    - **tests.py**: Unit tests.\n    - **urls.py**: URL configuration for the portal app, mapping URLs to views.\n    - **views.py**: View functions or classes. Views handle HTTP requests and return HTTP responses.\n\n  - **manage.py**: Django's command-line utility for administrative tasks.\n  - **requirements.txt**: Txt file that holds all of the projects dependencies.\n\n## Getting the server running\n\n\n1. In a new terminal run `pip install -r requirements.txt `\n2. in ./vercel_app folder, create a new file called local_settings.py and add\n\n```\nfrom pathlib import Path\n\nBASE_DIR = Path(__file__).resolve().parent.parent\n\nDEBUG=True\n```\n3. In ./vercel_app folder, create a new file called .env and add the environment variables from our project discord channel 8bit-ste\n\n4. Start the app by running `python manage.py runserver` in terminal, the app should be running locally on port 8000, http://localhost:8000\n\n## Frontend development\n1. Have three terminals open; one for  the server, npm related commands and one for running __python manage.py collectstatic__\n2. In your first terminal, start the server with __python manage.py runserver__\n3. In your second terminal, cd into the frontend with __cd main_app/frontend__ then run npm run dev\nThis will render out the JavaScript files into the static/dist folder\n4. In your third terminal, everytime you make a change to frontend src files, run __python manage.py collectstatic__ to apply the changes.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F8bituhm%2F8bit-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F8bituhm%2F8bit-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F8bituhm%2F8bit-site/lists"}