https://github.com/spokanetech/spokanetechweb
source code for spokanetech.org
https://github.com/spokanetech/spokanetechweb
Last synced: about 1 year ago
JSON representation
source code for spokanetech.org
- Host: GitHub
- URL: https://github.com/spokanetech/spokanetechweb
- Owner: SpokaneTech
- License: gpl-3.0
- Created: 2024-11-24T23:26:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-16T23:01:54.000Z (about 1 year ago)
- Last Synced: 2025-04-17T11:56:24.923Z (about 1 year ago)
- Language: Python
- Size: 986 KB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SpokaneTech.org
Home of SpokaneTech.org, an online hub for Spokane's tech events and groups. It's not just a website; it's a community-driven, open-source initiative aimed at fostering learning and collaboration among aspiring and seasoned tech enthusiasts.
See the live site here:
https://www.spokanetech.org
Follow development here:
https://spokanetech.github.io/blog/building-spokane-tech/intro/
## Code Quality
| Workflow | Description | Status |
|----------|-------------------------|------------------------------------------------------------------------------|
|Bandit|security checks||
|Isort|python import ordering||
|Mypy|static type checking||
|Radon|code complexity analysis||
|Ruff Format|code formatting||
|Ruff Lint|static code analysis||
## Local Development
### prerequisites
1. git installed on system
2. python installed on system (3.10+ recommended)
### local git setup
1. clone the repo:
```
git clone git@github.com:SpokaneTech/SpokaneTechWeb.git
```
2. git config (optional)
To enable pre-commit code quality checks, update the location of git hooks with the following command:
```shell
git config core.hooksPath .github/hooks
```
Note: to make a commit with the precommit hooks temporarily disabled, run the following:
```
git commit --no-verify
```
### local environment setup steps
1. cd into the repo directory
```
cd SpokaneTechWeb
```
2. create a python virtual environment
```
python -m venv venv
```
3. activate the python virtual environment
for linux, mac, or wsl:
```
source venv/bin/activate
```
for powershell:
```powershell
venv\Scripts\activate
```
4. install the python dependencies
```
pip install .[dev]
```
** mac users may need to use quotes, such as ```pip install ."[dev]"```
5. (optional) create a custom .env file and update contents as applicable
```
cp src/envs/.env.template src/envs/.env.local
```
6. cd to the django_project directory
```
cd src/django_project
```
7. create a local database by running django migrations
```
./manage.py migrate
```
8. create a local admin user
```
./manage.py add_superuser --group admin
```
9. (optional) add platforms and groups to your local database
```
./manage.py runscript initialize_data
```
10. (optional) ingest future events to your local database
```
./manage.py runscript ingest_events
```
Note: this requires playwright and its dependencies to be installed on your system.
```playwright install --with-deps```
11. start the local demo server
```
./manage.py runserver
```
open a browser and navigate to http://127.0.0.1:8000 (log in with admin/admin)
** you can stop the local demo server anytime via ```ctrl + c ```