dating-website/README.md
2026-03-04 19:00:19 +00:00

31 lines
1.4 KiB
Markdown

# Dating-Website
## Description
Minimal dating website made in python.
It uses flask to render the HTML, saves the data in a MySQL database and also features an authentication method using PGP where the database stores the user's PGP key's fingerprint and uses that to encrypt a message only you decrypt, but successfully decrypting the message you athenticate to your account.
It's also supposed to be very easy to use, currently its still in development but the vision is that you can be enganged on the website right from the start featuring a very powerfull search page and not needing an account to use the website.
This website also does not use JavaScript making it easy to run on any browser.
## TODO
- making the website responsive
- adding search features
- likes and dislikes
- cool css
- a grid with all of the users on the index page (where the search will also be)
- security audits
- maybe more stuff later...
## Contributing
If you have suggestions, find bugs, or want to provide code, just open an issue before submiting a PR. I will probably not accept a PR unless I see that it's actually somewhat important, exceptions can be made, but its kinda goofy to write the code before submiting an issue.
## Running the program
#### Docker/Podman
`docker compose up -d` / `podman-compose up -d`
### python enviornment
`python -m venv venv`
### Install the dependencies
`pip install -r requirements.txxt`
### Run the program
`pyhton src/main.py`