Skip to content

Commit

Permalink
Add more content to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaszkadziela committed Mar 24, 2024
1 parent b4634aa commit d9b4cd6
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
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

0 comments on commit d9b4cd6

Please sign in to comment.