About WikiCenter

It is a Wiki software :)

The creation and outline can be read on this Blog Post

Visit Youtube Playlist to see live coding sessions on this repository.

Roadmap

Visit TODO's

Running locally

With Docker Desktop

After clone the project you need to take the following steps:

1. Run the composer install

   composer install

2. Copy the .env.example file and create new one

   cp .env.example .env

3. Generate a key

   php artisan key:generate

4. Build container

   ./vendor/bin/sail up

5. Run the migrations

   sail artisan migrate

6. Seed database with dummy data

   sail artisan db:seed

   In case you are running commands inside container, you just need to run php artisan db:seed without the prefix sail.

7. Install frontend dependencies

   npm install && npm run dev

8. Go to http://localhost/admin

9. Enjoy

Running WikiCenter on GitPod

GitPod is a Cloud Based Development Environment. It allows us to automate the creation of an environment on the cloud, to develop, check Features and PR previews live, onboarding people faster, pair programming, playgrounds, and more.

If you want to try it, open in GitPod. You can create an account in under a minute, using your Git provider of choice. You don't have to give any permissions to repositories, only to read your e-mail address.

The GitPod setup for this repository was made on a Youtube Live Session.

The tasks in .gitpod.yml will run.

After all the 4 tasks are running, the last one keeps running Vite.

You can now visit the app, for the link provided on local 80. (It will be public 443 SSL)

Then run, in an available terminal, (or a new one):

./vendor/bin/sail artisan migrate:fresh --seed

And now you can navigate to /admin. The login form will be filled for you automatically, just click Login :)

License

WikiCenter is open-sourced software licensed under the MIT license.