Skip to content

Commit 5872512

Browse files
authored
Update documentation and remove unused assets (#460)
1 parent 4b6dc4e commit 5872512

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+592
-668
lines changed

README.md

Lines changed: 12 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,12 @@
1-
>[!IMPORTANT]
2-
>This project is under development. Not all functionality is finished and much can still be improved. If you want to help with the development of the project, you can select an [issue](https://github.com/gomzyakov/larajournal/issues), do it and open a PR.
3-
4-
### Read this in [other languages](./translations/Translations.md):
5-
6-
[ગુજરાતી](translations/README.guj.md)
7-
· [हिन्दी](translations/README.hi.md)
8-
· [मराठी](translations/README.mr.md)
9-
· [മലയാളം](translations/README.ml.md)
10-
· [ಕನ್ನಡ](translations/README.ka.md)
11-
· [తెలుగు](translations/README.te.md)
12-
· [ଓଡିଆ](translations/README.od.md)
13-
· [ਪੰਜਾਬੀ](translations/README.pb.md)
14-
· [বাংলা](translations/README.bn.md)
15-
· [தமிழ்](translations/README.ta.md)
16-
· [မြန်မာ](translations/README.mm_unicode.md)
17-
· [Bahasa Indonesia](translations/README.id.md)
18-
· [Català](translations/README.ca.md)
19-
· [Español](translations/README.es.md)
20-
· [Nederlands](translations/README.nl.md)
21-
· [Русский](translations/README.ru.md)
22-
· [Bulgarian](translations/README.bg.md)
23-
· [Македонски](translations/README.mk.md)
24-
· [Magyar](translations/README.hu.md)
25-
· [Slovenčina](translations/README.slk.md)
26-
· [日本語](translations/README.ja.md)
27-
· [Tiếng Việt](translations/README.vn.md)
28-
· [Polski](translations/README.pl.md)
29-
· [فارسی](translations/README.fa.md)
30-
· [Lietuvių kalba](translations/README.lt.md)
31-
· [한국어](translations/README.ko.md)
32-
· [Deutsch](translations/README.de.md)
33-
· [中文(Simplified)](translations/README.zh-cn.md)
34-
· [中文(Traditional)](translations/README.zh-tw.md)
35-
· [ελληνικά](translations/README.gr.md)
36-
· [العربية](translations/README.ar.md)
37-
· [Українська](translations/README.ua.md)
38-
· [Português (Brasil)](/translations/README.pt-br.md)
39-
· [Português (Portugal)](translations/README.pt-pt.md)
40-
· [Italiano](translations/README.it.md)
41-
· [ภาษาไทย](translations/README.th.md)
42-
· [Galego](translations/README.gl.md)
43-
· [नेपाली](translations/README.np.md)
44-
· [اردو](translations/README.ur.md)
45-
· [Limba Română](translations/README.ro.md)
46-
· [English](README.md)
47-
· [Türkçe](translations/README.tr.md)
48-
· [עברית](translations/README.hb.md)
49-
· [Czech](translations/README.cs.md)
50-
· [Slovenščina](translations/README.sl.md)
51-
· [Norsk](translations/README.no.md)
52-
· [Svenska](translations/README.se.md)
53-
· [Dansk](translations/README.da.md)
54-
· [Wikang Filipino](translations/README.tl.md)
55-
· [Қазақша](translations/README.kz.md)
56-
· [Afrikaans (South Africa)](translations/README.afk.md)
57-
· [Zulu (South Africa)](translations/README.zul.md)
58-
· [Kiswahili (Kenya)](translations/README.kws.md)
59-
· [ქართული](translations/README.ge.md)
60-
· [Igbo (Nigeria)](translations/README.igb.md)
61-
· [Yoruba (Nigeria)](translations/README.yor.md)
62-
· [Hausa (Nigeria)](translations/README.hau.md)
63-
· [Suomeksi](translations/README.fi.md)
64-
· [Español de México](translations/README.mx.md)
65-
· [Српски](translations/README.sr.md)
66-
· [Latvia](translations/README.lv.md)
67-
· [Shqip](translations/README.al.md)
68-
· [Беларуская мова](translations/README.by.md)
69-
· [Azərbaycan dili](translations/README.aze.md)
70-
· [Bosanski](translations/README.bih.md)
71-
· [پښتو - Pashto](translations/README.ps.md)
72-
· [ພາສາລາວ](translations/README.la.md)
73-
· [Af-soomaali](translations/README.so.md)
74-
· [አማርኛ(Ethiopia)](translations/README.am.md)
75-
· [සිංහල(Sri Lanka)](translations/README.si.md)
76-
· [հայերեն](translations/README.arm.md)
77-
781
# Simple blog application based on Laravel
792

803
The goal of this repository is to showcase good [Laravel](https://laravel.com) development practices with a simple application.
814

5+
_Read this `README.md` in [other languages](./translations/Translations.md)._
6+
7+
>[!IMPORTANT]
8+
>This project is under development. Not all functionality is finished and much can still be improved. If you want to help with the development of the project, you can select an [issue](https://github.com/gomzyakov/laravel-blog/issues), do it and open a PR.
9+
8210
## Features
8311

8412
- 📚 Creating and editing posts
@@ -95,18 +23,16 @@ The goal of this repository is to showcase good [Laravel](https://laravel.com) d
9523

9624
![Laravel blog main page](docs/screenshot-main-page.png)
9725

98-
![Laravel blog admin panel](docs/screenshot-admin-panel.png)
99-
10026
## Requesting features
10127

102-
Open a new [issue](https://github.com/gomzyakov/larajournal/issues) to request a feature (or if you find a bug).
28+
Open a new [issue](https://github.com/gomzyakov/laravel-blog/issues) to request a feature (or if you find a bug).
10329

10430
## How to run blog locally?
10531

10632
Clone the project:
10733

10834
```bash
109-
git clone git@github.com:gomzyakov/larajournal.git
35+
git clone git@github.com:gomzyakov/laravel-blog.git
11036
```
11137

11238
I believe you already have Docker installed. If not, just do it on [Mac](https://docs.docker.com/desktop/install/mac-install/), [Windows](https://docs.docker.com/desktop/install/windows-install/) or [Linux](https://docs.docker.com/desktop/install/linux-install/).
@@ -117,7 +43,7 @@ Copy the environment settings:
11743
cp .env.local .env
11844
```
11945

120-
Build the `larajournal` image with the following command:
46+
Build the `laravel-blog` image with the following command:
12147

12248
```bash
12349
docker compose build --no-cache
@@ -156,14 +82,14 @@ And open http://127.0.0.1:8000 in your favorite browser. Happy using Laravel Blo
15682
Access to the Docker container:
15783

15884
```bash
159-
docker exec -ti larajournal-app bash
85+
docker exec -ti laravel-blog-app bash
16086
```
16187

16288
## License
16389

16490
This is open-sourced software licensed under the [MIT License](https://github.com/gomzyakov/php-code-style/blob/main/LICENSE).
16591

16692

167-
[![GitHub release](https://img.shields.io/github/release/gomzyakov/larajournal.svg)](https://github.com/gomzyakov/larajournal/releases/latest)
168-
[![license](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/larajournal/blob/development/LICENSE)
169-
[![codecov](https://codecov.io/gh/gomzyakov/larajournal/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/larajournal)
93+
[![GitHub release](https://img.shields.io/github/release/gomzyakov/laravel-blog.svg)](https://github.com/gomzyakov/laravel-blog/releases/latest)
94+
[![license](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/laravel-blog/blob/development/LICENSE)
95+
[![codecov](https://codecov.io/gh/gomzyakov/laravel-blog/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/laravel-blog)

docker-compose.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ services:
66
uid: 1000
77
context: ./
88
dockerfile: Dockerfile
9-
image: larajournal
10-
container_name: larajournal-app
9+
image: laravel-blog
10+
container_name: laravel-blog-app
1111
restart: unless-stopped
1212
working_dir: /var/www/
1313
volumes:
@@ -17,7 +17,7 @@ services:
1717

1818
db:
1919
image: mysql:9.1
20-
container_name: larajournal-db
20+
container_name: laravel-blog-db
2121
restart: unless-stopped
2222
environment:
2323
MYSQL_DATABASE: ${DB_DATABASE}
@@ -35,7 +35,7 @@ services:
3535

3636
nginx:
3737
image: nginx:1.27-alpine
38-
container_name: larajournal-nginx
38+
container_name: laravel-blog-nginx
3939
restart: unless-stopped
4040
ports:
4141
- "8000:80"

docs/deploy.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Deploy LaraJournal to VDS
1+
# Deploy laravel blog to VDS
22

33
For simplicity, we will deploy the project to VDS. The deployment process consists of several steps:
44

@@ -97,19 +97,19 @@ After that, in the GitHub repository, in the `Settings > Secrets > Actions` sect
9797
9898
## Clone repository from GitHub
9999
100-
Go to path `/var/www/web/sites` and clone current repository (or your own fork). For example, use `larajournal.com` folder name:
100+
Go to path `/var/www/web/sites` and clone current repository (or your own fork). For example, use `laravel-blog.com` folder name:
101101
102102
```bash
103103
cd /var/www/web/sites
104-
git clone git@github.com:gomzyakov/larajournal.git larajournal.com
104+
git clone git@github.com:gomzyakov/laravel-blog.git laravel-blog.com
105105
cd secretic
106106
```
107107
108-
Where `larajournal.com` is the domain that you previously purchased and under which your website will be visible.
108+
Where `laravel-blog.com` is the domain that you previously purchased and under which your website will be visible.
109109
110110
## Set up Laravel
111111
112-
Then go to path `/var/www/web/sites/larajournal.com` and run some commands:
112+
Then go to path `/var/www/web/sites/laravel-blog.com` and run some commands:
113113
114114
```bash
115115
php -r "file_exists('.env') || copy('.env.ci', '.env');"
@@ -122,16 +122,16 @@ php artisan key:generate
122122
- Create a `secretnotes` database via phpMyAdmin
123123
- Run migrations `php artisan migrate:fresh --seed`
124124
125-
Open assigned to VDS URL (like `dd`) in your favorite browser. Happy using LaraJournal app!
125+
Open assigned to VDS URL (like `dd`) in your favorite browser. Happy using laravel blog app!
126126
127127
128128
## Optional: Make domain aliases (if needed)
129129
130130
```bash
131131
cd /var/www/web/sites
132-
ln -s larajournal.com www.larajournal.com
133-
ln -s larajournal.com larajournal.io
134-
ln -s larajournal.com laravelblog.com
132+
ln -s laravel-blog.com www.laravel-blog.com
133+
ln -s laravel-blog.com laravel-blog.io
134+
ln -s laravel-blog.com laravelblog.com
135135
```
136136
137137
## Optional: Set up HTTPS

docs/https.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ sudo certbot --nginx
4242
If you wish to add another SSL-certificate, just run:
4343

4444
```bash
45-
sudo certbot certonly --nginx --agree-tos --expand -d larajournal.com
45+
sudo certbot certonly --nginx --agree-tos --expand -d laravel-blog.com
4646
```
4747

48-
Where `larajournal.com` is the domain that you previously purchased and under which your website will be visible.
48+
Where `laravel-blog.com` is the domain that you previously purchased and under which your website will be visible.

docs/screenshot-admin-panel.png

-1.1 MB
Binary file not shown.

translations/README.afk.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
>This file needs to updated in order to match the [english](/README.md) README file.
33
>Hierdie lêer moet opgedateer word om by die [engelse](/README.md) README lêer te pas
44
5-
![larajournal met Filament-administrasiepaneel](../docs/social-preview-en.png)
5+
![laravel-blog met Filament-administrasiepaneel](../docs/social-preview-en.png)
66

77
_Read this in [other languages](./Translations.md)_
88

9-
>This file is automatically translated. If you notice an error, please correct it yourself (by making a PR) or write about it in the [issues](https://github.com/gomzyakov/larajournal/issues).
9+
>This file is automatically translated. If you notice an error, please correct it yourself (by making a PR) or write about it in the [issues](https://github.com/gomzyakov/laravel-blog/issues).
1010
11-
# larajournal met Filament-administrasiepaneel
11+
# laravel-blog met Filament-administrasiepaneel
1212

1313
Dit is [Laravel](https://laravel.com) blogbeginstelprojek met [Filament](https://filamentphp.com) adminpaneel.
1414

@@ -23,19 +23,19 @@ Die doel van hierdie bewaarplek is om goeie [Laravel](https://laravel.com) ontwi
2323

2424
## Versoek kenmerke
2525

26-
Maak 'n [nuwe uitgawe](https://github.com/gomzyakov/larajournal/issues/new) oop om 'n kenmerk aan te vra (of as jy 'n fout vind).
26+
Maak 'n [nuwe uitgawe](https://github.com/gomzyakov/laravel-blog/issues/new) oop om 'n kenmerk aan te vra (of as jy 'n fout vind).
2727

2828
## Hoe om 'n blog plaaslik te bestuur?
2929

3030
Kloon die projek:
3131

3232
``` bash
33-
git clone git@github.com:gomzyakov/larajournal.git
33+
git clone git@github.com:gomzyakov/laravel-blog.git
3434
```
3535

3636
Ek glo jy het reeds Docker geïnstalleer. Indien nie, doen dit net op [Mac](https://docs.docker.com/desktop/install/mac-install/), [Windows](https://docs.docker.com/desktop/install/windows -install/) of [Linux](https://docs.docker.com/desktop/install/linux-install/).
3737

38-
Bou die `larajournal`-prent met die volgende opdrag:
38+
Bou die `laravel-blog`-prent met die volgende opdrag:
3939

4040
``` bash
4141
docker compose build --no-cache
@@ -80,14 +80,14 @@ En maak http://127.0.0.1:8000 oop in jou gunsteling blaaier. Lekker om Laravel B
8080
Toegang tot die Docker-houer:
8181

8282
``` bash
83-
docker exec -ti larajournal-app bash
83+
docker exec -ti laravel-blog-app bash
8484
```
8585

8686
## Lisensie
8787

8888
Dit is oopbronsagteware gelisensieer onder die [MIT-lisensie](https://github.com/gomzyakov/php-code-style/blob/main/LICENSE).
8989

9090

91-
[![GitHub-vrystelling](https://img.shields.io/github/release/gomzyakov/larajournal.svg)](https://github.com/gomzyakov/larajournal/releases/latest)
92-
[![lisensie](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/larajournal/blob/development/LICENSE)
93-
[![codecov](https://codecov.io/gh/gomzyakov/larajournal/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/ larajournal)
91+
[![GitHub-vrystelling](https://img.shields.io/github/release/gomzyakov/laravel-blog.svg)](https://github.com/gomzyakov/laravel-blog/releases/latest)
92+
[![lisensie](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/laravel-blog/blob/development/LICENSE)
93+
[![codecov](https://codecov.io/gh/gomzyakov/laravel-blog/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/ laravel-blog)

translations/README.al.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
_Read this in [other languages](./Translations.md)_
88

9-
>This file is automatically translated. If you notice an error, please correct it yourself (by making a PR) or write about it in the [issues](https://github.com/gomzyakov/larajournal/issues).
9+
>This file is automatically translated. If you notice an error, please correct it yourself (by making a PR) or write about it in the [issues](https://github.com/gomzyakov/laravel-blog/issues).
1010
1111
# Blog Laravel me panelin e administrimit të Filament
1212

@@ -23,19 +23,19 @@ Qëllimi i kësaj depoje është të shfaqë praktikat e mira të zhvillimit [La
2323

2424
## Duke kërkuar veçori
2525

26-
Hapni një [problem të ri](https://github.com/gomzyakov/larajournal/issues/new) për të kërkuar një veçori (ose nëse gjeni një gabim).
26+
Hapni një [problem të ri](https://github.com/gomzyakov/laravel-blog/issues/new) për të kërkuar një veçori (ose nëse gjeni një gabim).
2727

2828
## Si të drejtoni blogun në nivel lokal?
2929

3030
Klononi projektin:
3131

3232
```bash
33-
git clone git@github.com:gomzyakov/larajournal.git
33+
git clone git@github.com:gomzyakov/laravel-blog.git
3434
```
3535

3636
Besoj se tashmë e keni të instaluar Docker. Nëse jo, thjesht bëjeni në [Mac](https://docs.docker.com/desktop/install/mac-install/), [Windows](https://docs.docker.com/desktop/install/windows -install/) ose [Linux] (https://docs.docker.com/desktop/install/linux-install/).
3737

38-
Ndërtoni imazhin `larajournal` me komandën e mëposhtme:
38+
Ndërtoni imazhin `laravel-blog` me komandën e mëposhtme:
3939

4040
```bash
4141
docker compose build --no-cache
@@ -86,14 +86,14 @@ Dhe hapni http://127.0.0.1:8000 në shfletuesin tuaj të preferuar. I lumtur duk
8686
Qasja në kontejnerin Docker:
8787

8888
```bash
89-
docker exec -ti larajournal-app bash
89+
docker exec -ti laravel-blog-app bash
9090
```
9191

9292
## Liçensë
9393

9494
Ky është softuer me burim të hapur i licencuar sipas [licencës MIT](https://github.com/gomzyakov/php-code-style/blob/main/LICENSE).
9595

9696

97-
[![Lëshimi i GitHub](https://img.shields.io/github/release/gomzyakov/larajournal.svg)](https://github.com/gomzyakov/larajournal/releases/latest)
98-
[![licencë](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/larajournal/blob/development/LICENSE)
99-
[![codecov](https://codecov.io/gh/gomzyakov/larajournal/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/ larajournal)
97+
[![Lëshimi i GitHub](https://img.shields.io/github/release/gomzyakov/laravel-blog.svg)](https://github.com/gomzyakov/laravel-blog/releases/latest)
98+
[![licencë](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/laravel-blog/blob/development/LICENSE)
99+
[![codecov](https://codecov.io/gh/gomzyakov/laravel-blog/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/ laravel-blog)

translations/README.am.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
_Read this in [other languages](./Translations.md)_
88

9-
>This file is automatically translated. If you notice an error, please correct it yourself (by making a PR) or write about it in the [issues](https://github.com/gomzyakov/larajournal/issues).
9+
>This file is automatically translated. If you notice an error, please correct it yourself (by making a PR) or write about it in the [issues](https://github.com/gomzyakov/laravel-blog/issues).
1010
1111
# የላራቭል ብሎግ ከፋይላመንት አስተዳዳሪ ፓነል ጋር
1212

@@ -23,14 +23,14 @@ _Read this in [other languages](./Translations.md)_
2323

2424
## የመጠየቅ ባህሪዎች
2525

26-
ባህሪን ለመጠየቅ (ወይም ሳንካ ካገኙ) [አዲስ እትም](https://github.com/gomzyakov/larajournal/issues/new) ይክፈቱ።
26+
ባህሪን ለመጠየቅ (ወይም ሳንካ ካገኙ) [አዲስ እትም](https://github.com/gomzyakov/laravel-blog/issues/new) ይክፈቱ።
2727

2828
## ብሎግ በአገር ውስጥ እንዴት እንደሚሰራ?
2929

3030
ፕሮጀክቱን መዝጋት;
3131

3232
```bash
33-
git clone git@github.com:gomzyakov/larajournal.git
33+
git clone git@github.com:gomzyakov/laravel-blog.git
3434
```
3535

3636
አስቀድመህ Docker እንደተጫነህ አምናለሁ። ካልሆነ፣ ልክ በ[Mac](https://docs.docker.com/desktop/install/mac-install/)[Windows](https://docs.docker.com/desktop/install/windows) ላይ ያድርጉት። -install/) ወይም [Linux](https://docs.docker.com/desktop/install/linux-install/)
@@ -86,14 +86,14 @@ docker compose exec መተግበሪያ ./artisan make:filament-user
8686
ወደ ዶከር መያዣው መድረስ;
8787

8888
```bash
89-
docker exec -ti larajournal-app bash
89+
docker exec -ti laravel-blog-app bash
9090
```
9191

9292
## ፈቃድ
9393

9494
ይህ በ[MIT ፈቃድ](https://github.com/gomzyakov/php-code-style/blob/main/LICENSE) ስር ፈቃድ ያለው ክፍት ምንጭ ሶፍትዌር ነው።
9595

9696

97-
[![GitHub ልቀት](https://img.shields.io/github/release/gomzyakov/larajournal.svg)](https://github.com/gomzyakov/larajournal/releases/latest)
98-
[![license](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/larajournal/blob/development/LICENSE)
99-
[![codecov](https://codecov.io/gh/gomzyakov/larajournal/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/ ላራቬል-ብሎግ)
97+
[![GitHub ልቀት](https://img.shields.io/github/release/gomzyakov/laravel-blog.svg)](https://github.com/gomzyakov/laravel-blog/releases/latest)
98+
[![license](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/gomzyakov/laravel-blog/blob/development/LICENSE)
99+
[![codecov](https://codecov.io/gh/gomzyakov/laravel-blog/branch/main/graph/badge.svg?token=4CYTVMVUYV)](https://codecov.io/gh/gomzyakov/ ላራቬል-ብሎግ)

0 commit comments

Comments
 (0)