Skip to content

Commit 16d1706

Browse files
author
Jan Ruhfus
authored
Add files via upload
0 parents  commit 16d1706

File tree

2 files changed

+126
-0
lines changed

2 files changed

+126
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 KrbDevelopment
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
<p align="center">
2+
<img src="https://i.imgur.com/9kksNkw.png"/>
3+
</p>
4+
<p align="center">
5+
<a href="https://on.cypress.io">Documentation</a> |
6+
<a href="https://on.cypress.io/changelog">Changelog</a> |
7+
<a href="https://on.cypress.io/roadmap">Roadmap</a>
8+
</p>
9+
10+
11+
<h3 align="center">
12+
Currently under heavy development & testing.
13+
</h3>
14+
15+
<p align="center">
16+
Fast, easy and reliable wiki software running in the web.
17+
</p>
18+
19+
<p align="center">
20+
<a href="https://github.com/KrbDevelopment">
21+
<img src="https://i.imgur.com/lk2p7IU.png" width="200" />
22+
</a>
23+
</p>
24+
25+
## What is Articly?
26+
27+
<p align="center">
28+
Articly is a open-source & free wiki software based on Vue.js & TailwindCSS in the frontend and Laravel in the backend.
29+
30+
<img alt="Overview Screenshot" src="https://i.imgur.com/qvCtJIF.png" />
31+
32+
<img alt="Overview Screenshot" src="https://i.imgur.com/xGl5oOc.png" />
33+
</p>
34+
35+
## Installing
36+
37+
<img src="https://i.imgur.com/HrtcGGA.png" width="200" />
38+
<img src="https://i.imgur.com/K8lWuuc.png" width="200" />
39+
<img src="https://i.imgur.com/bzi2Ckq.png" width="200" />
40+
41+
Install Cypress for Nginx, then [get started](./DOCUMENTATION.md).
42+
43+
```bash
44+
git clone https://github.com/KrbDevelopment/Wiki-Software && cd Wiki-Software
45+
```
46+
47+
### Installing Frontend
48+
```bash
49+
cd Frontend
50+
npm i
51+
npm run build
52+
```
53+
54+
Point your webserver configuration onto the `dist`-folder's index.html. Double-check if the webserver has access to your `dist`-folder by using:
55+
56+
```bash
57+
chown -R www-data:www-data dist
58+
```
59+
60+
For development purposes, you can use `npm run serve` instead of `npm run build`. This will launch a local dev server on port 8080.
61+
62+
### Installing Backend
63+
64+
```bash
65+
cd Backend
66+
composer i
67+
```
68+
69+
Copy over the .env.example file into a file called .env. Fill out all important data, except for the `APP_KEY`.
70+
71+
Generate the app key by:
72+
```bash
73+
php artisan key:generate
74+
```
75+
76+
Install & setup passport for authentication:
77+
```bash
78+
php artisan passport:install
79+
```
80+
81+
Migrate database:
82+
```bash
83+
php artisan migrate
84+
```
85+
86+
Link storage folder for accessing images:
87+
```bash
88+
php artisan storage:link
89+
```
90+
91+
Optional: If you're experiencing weird error's, clearing the cache could help you:
92+
```bash
93+
php artisan optimize
94+
```
95+
96+
97+
## Contributing
98+
99+
Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps.
100+
101+
## License
102+
103+
<a href="./LICENSE"><img src="https://i.imgur.com/3dWTkcP.png" width="200" /></a>
104+
105+
This project is licensed under the terms of the [MIT license](/LICENSE).

0 commit comments

Comments
 (0)