-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bb16635
commit 203aaaa
Showing
1 changed file
with
2 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,7 @@ | ||
| # What is "Submit?" | ||
| # What is sakura? | ||
|
|
||
| Submit is imageboard-style social platform created in PHP with JS front-end components. It doesn't have any fancy functionality - mainly designed to just work with all features already introduced | ||
|
|
||
| # How to deploy the project? | ||
|
|
||
| In source code, there is "docker" directory, go into it, add to docker-compose.yml environmental variables and run | ||
|
|
||
| ```bash | ||
| docker-compose up -d --build | ||
| ``` | ||
|
|
||
| Then, enter database container using command: | ||
|
|
||
| ```bash | ||
| docker exec -it submit2_db sh | ||
| ``` | ||
|
|
||
| and enter the mysql CLI. Then create database "submit". Next, exit container and run | ||
|
|
||
| ```bash | ||
| docker exec -it submit2_app sh | ||
| ``` | ||
|
|
||
| and migrate migrations: | ||
|
|
||
| ```bash | ||
| symfony console doctrine:migrations:migrate | ||
| ``` | ||
|
|
||
| # What actually works? | ||
|
|
||
| - registering/loging users (via Auth0 API) | ||
| - creating threads and comments | ||
| - popping-up modals for creating post and comment | ||
| - uploading files | ||
| - refreshing without page reload (thanks to react.js) | ||
| - desktop/mobile version | ||
| - logout | ||
| - search engine (at the moment only searches thread's content) | ||
|
|
||
| # What doesn't work nor implemented yet? | ||
|
|
||
| - comment/post deletion (this feature was implemented in Submit 1.0 but it was broken so it's not implemented yet) | ||
| - comment/post sanitization | ||
| - comment/post cooldown | ||
| - pop-ups after refreshing, making new thread etc. | ||
| - public user profiles (this idea has to be considered deeply) | ||
| - following mechanism | ||
| - post reporting mechanism | ||
| - design sucks, I'm afraid of it | ||
| - administration panels | ||
| - error handling (for example when sending too large image, only error shows in API's response) | ||
| - any unit tests, ~~I'm too dumb for this~~ n-no need for them actually when everything works ehehe~ | ||
|
|
||
| # Can I contribute? | ||
|
|
||
| Of course, but if you like to, text me so we can consider changes and ideas. Also feel free to contact me with any feedback you have | ||
| sakura is imageboard engine created in PHP with JS front-end components. Project is under development and yet no official (and unofficial) release has been created | ||
|
|
||
| # Did Gomez know about fire wizards murder? | ||
|
|
||
| [no.](https://youtu.be/uAsIRW86750) | ||
|
|
||
| # Images gallery | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  |