Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osmianski/docs
A SaaS that renders a mega website from lots of Git repositories. Built with Laravel, Vue.js and Inertia.js.
https://github.com/osmianski/docs
alpinejs docs laravel livewire
Last synced: 29 days ago
JSON representation
A SaaS that renders a mega website from lots of Git repositories. Built with Laravel, Vue.js and Inertia.js.
- Host: GitHub
- URL: https://github.com/osmianski/docs
- Owner: osmianski
- Created: 2022-09-20T06:44:48.000Z (over 2 years ago)
- Default Branch: v0.3
- Last Pushed: 2023-06-03T02:57:23.000Z (over 1 year ago)
- Last Synced: 2023-06-03T03:24:16.651Z (over 1 year ago)
- Topics: alpinejs, docs, laravel, livewire
- Language: PHP
- Homepage:
- Size: 1.71 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Docs
A SaaS that renders a mega website from lots of Git repositories. Built with Laravel, Vue.js and Inertia.js.
## Prerequisites
1. Install [PHP, Composer, Docker](https://laravel.com/docs/10.x).
2. Create an [alias for `sail` command](https://laravel.com/docs/10.x/sail#configuring-a-shell-alias)
## Installation
1. Clone the project from GitHub:
```shell
cd ~/projects
git clone [email protected]:osmianski/docs.git
cd docs
npm install
```
2. In a separate terminal window, start the Docker containers for the project:
```shell
cd ~/projects/docs
sail up
```
3. In a separate terminal window, run Vite asset build script:
```shell
cd ~/projects/docs
npm run dev
```
4. In a separate terminal window, run the database migrations:
```shell
cd ~/projects/docs
sail artisan migrate:fresh --seed
```
5. Open the local copy of the website in the browser: .
6. Copy Git hooks:
```shell
cd ~/projects/docs
chmod a+x git-hooks/*
cp git-hooks/* .git/hooks/
```
## Documentation
The project documentation is available at .
## Previous effort
### v0.2
[`v0.2`](https://github.com/osmianski/docs/tree/v0.2) was a SaaS that renders a mega website from lots of Git repositories. Built with Laravel, Livewire and Alpine.js.
There was just basic installation of the TALL stack, almost nothing more.
### v0.1
[`v0.1`](https://github.com/osmianski/docs/tree/v0.1) was a SaaS that turns Notion workspaces and GitHub repositories into beautiful documentation websites. Built with Laravel, Vue.js and Inertia.js. It was abandoned in 2023. It has some good reusable bits:
* A GitHub action that auto-updates the dependencies.
* A Notion client that can be used to fetch data from Notion.