Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hkaar/caulio
A forum website created with vue.js and Laravel
https://github.com/hkaar/caulio
Last synced: 13 days ago
JSON representation
A forum website created with vue.js and Laravel
- Host: GitHub
- URL: https://github.com/hkaar/caulio
- Owner: Hkaar
- License: apache-2.0
- Created: 2024-04-20T01:52:07.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-05-13T12:45:41.000Z (8 months ago)
- Last Synced: 2024-05-13T13:48:16.616Z (8 months ago)
- Language: PHP
- Size: 1.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Caulio
[](https://opensource.org/licenses/Apache-2.0)
A web-based forum website created using Vue.js and Laravel
## Requirements
- PHP version >= 8.1
- Composer
- Node.js
## User Guide
Here's a guide for any users who want to host this on their own
Clone the repo
```bash
git clone https://github.com/Hkaar/Caulio.git
```
Go to the project directory
```bash
cd Caulio
```
Install all the php dependecies
```bash
composer install
```
Install all the node dependecies
```bash
npm install
```
Run the migrations
```bash
php artisan migrate
```
Generate the app key
```bash
php artisan key:generate
```
And then serve it
```bash
php artisan serve
```
## Contributor Guide
Here we will list the guide on how to contribute to this project
### Step 1 : Setup the project
Clone the repo
```bash
git clone https://github.com/Hkaar/Caulio.git
```
Go to the project directory
```bash
cd Caulio
```
Install all the php dependecies
```bash
composer install
```
Install all the node dependecies
```bash
npm install
```
Setup the env variables
`Bash :`
```bash
mv .env.example .env && cp .env .env.example
```
`Powershell :`
```powershell
Rename-Item .\.env.example .\.env ; Copy-Item .\.env .\.env.example
```
Run the migrations
```bash
php artisan migrate
```
Generate the app key
```bash
php artisan key:generate
```
And then serve to test if it's working
```bash
php artisan serve
```
### Step 2 : Work Setup
Go to the project directory (if you haven't done so)
```bash
cd Caulio
```
Update the master branch first
```bash
git pull origin master
```
Create a branch for your feature
```bash
git branch
```
And then switch your branch to your newly created one
```bash
git checkout
```
### Step 3 : How to work
If you want to save something, first add it to staging
by adding the root
```bash
git add .
```
or by adding a specific file
```bash
git add
```
And then commiting it to the branch
```bash
git commit -m ""
```
### Step 4 : Uploading
Once done with developing your feature, upload it to the repo
by pushing it
```bash
git push origin
```
And then create a pull request for us to review and merge
### Step 5 : Cleanup
If the pull request is accepted, update your local repo with the changes
```bash
git checkout master
git pull origin master
```
```bash
git branch -d
```
### Tips
Don't forget to always do a pull from the remote master to update your local repo!
```bash
git pull origin master
```
And that's all, btw here's a table for your reward
ʕノ•ᴥ•ʔノ ︵ ┻━┻