mirror of
https://github.com/solidtime-io/solidtime.git
synced 2026-06-15 05:22:44 +01:00
add reverse proxy setup and setup instructions
This commit is contained in:
43
README.md
43
README.md
@@ -1,2 +1,45 @@
|
||||
# Time-tracking project
|
||||
|
||||
## Setup the Project
|
||||
|
||||
System Requirements:
|
||||
* Docker
|
||||
* PHP 8.2
|
||||
* Composer
|
||||
|
||||
```bash
|
||||
composer install
|
||||
|
||||
cp .env.example .env
|
||||
|
||||
./vendor/bin/sail up -d
|
||||
|
||||
./vendor/bin/sail artisan key:generate
|
||||
|
||||
./vendor/bin/sail artisan migrate:fresh --seed
|
||||
|
||||
./vendor/bin/sail npm install
|
||||
|
||||
./vendor/bin/sail npm run build
|
||||
|
||||
```
|
||||
|
||||
Make sure to set the APP_PORT and VITE_PORT inside your `.env` file to a port that is not already used by your system.
|
||||
|
||||
## Setup with Reverse Proxy
|
||||
|
||||
Additional System Requirements:
|
||||
* Traefik 2 Reverse-Proxy (https://github.com/korridor/reverse-proxy-docker-traefik)
|
||||
|
||||
Add the following entry to your `/etc/hosts`
|
||||
|
||||
```
|
||||
127.0.0.1 time-tracking.local
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
This project is in a very early stage. The structure and APIs are still subject to change and not stable.
|
||||
Therefore we do not currently accept any contributions, unless you are a member of the team.
|
||||
|
||||
As soon as we feel comfortable enough that the application structure is stable enough, we will open up the project for contributions.
|
||||
|
||||
Reference in New Issue
Block a user