Update README.md
This commit is contained in:
parent
ccf0729630
commit
ae07e823da
1 changed files with 1 additions and 9 deletions
10
README.md
10
README.md
|
|
@ -5,19 +5,11 @@ It uses flask to render the HTML, saves the data in a MySQL database and also fe
|
||||||
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.
|
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.
|
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
|
## 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.
|
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
|
## Running the program
|
||||||
|
### start the database:
|
||||||
#### Docker/Podman
|
#### Docker/Podman
|
||||||
`docker compose up -d` / `podman-compose up -d`
|
`docker compose up -d` / `podman-compose up -d`
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue