Documentation | Changelog | Roadmap

Currently under heavy development & testing.

Fast, easy and reliable wiki software running in the web.

What is Articly?

Articly is a open-source & free wiki software based on Vue.js & TailwindCSS in the frontend and Laravel in the backend.

Installing

Install Articly for Nginx and get started.

Installing Frontend

git clone https://github.com/KrbDevelopment/Articly-Frontend
cd Articly-Frontend
npm i
npm run build

Copy over the .env.sample file into a file called .env. Fill out all data.

Point your webserver configuration onto the dist-folder's index.html. Double-check if the webserver has access to your dist-folder by using:

chown -R www-data:www-data dist

For development purposes, you can use npm run serve instead of npm run build. This will launch a local dev server on port 8080.

Installing Backend

git clone https://github.com/KrbDevelopment/Articly-Backend
cd Articly-Backend
composer i

Copy over the .env.example file into a file called .env. Fill out all important data, except for the APP_KEY.

Generate the app key by:

php artisan key:generate

Install & setup passport for authentication:

php artisan passport:install

Migrate database:

php artisan migrate

Link storage folder for accessing images:

php artisan storage:link

Optional: If you're experiencing weird error's, clearing the cache could help you:

php artisan optimize 

Contributing

Please see our Contributing Guideline which explains repo organization, linting, testing, and other steps.

License

This project is licensed under the terms of the MIT license.