-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
494ab50
commit 8c99782
Showing
1 changed file
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,43 @@ | ||
# kadziela.pl | ||
# Website kadziela.pl | ||
|
||
## A few words of introduction: | ||
This is a website I created to simplify switching between different projects available within [kadziela.pl](https://kadziela.pl) domain. | ||
|
||
## Used technologies: | ||
* HTML | ||
* CSS | ||
* Tailwind CSS | ||
* JavaScript | ||
* PHP | ||
* Laravel | ||
|
||
## Prerequisites: | ||
* Install and set up [Laravel Homestead](https://laravel.com/docs/11.x/homestead) | ||
|
||
## How to set up locally? | ||
1. Clone the repository | ||
``` | ||
$ git clone https://github.com/jonaszkadziela/kadziela.pl.git | ||
``` | ||
1. Enter **kadziela.pl** project directory | ||
``` | ||
$ cd kadziela.pl | ||
``` | ||
1. Install all dependencies | ||
``` | ||
$ npm install | ||
``` | ||
1. Run development web server | ||
``` | ||
$ npm run dev | ||
``` | ||
1. Project should be running at [kadziela.test](http://kadziela.test) | ||
|
||
## Development: | ||
* This project follows directory structure and standards defined in [Laravel documentation](https://laravel.com/docs/11.x/structure) | ||
* The following custom `npm` commands are available in this project: | ||
* `build`: Builds production project using Vite. Makes optimizations for production | ||
* `dev`: Starts a development server that serves the project at [kadziela.test](http://kadziela.test) | ||
|
||
## Links: | ||
* Live website: https://kadziela.pl |