Skip to content

Commit 3882f51

Browse files
committed
Add installation information to readme
1 parent eb3e2ca commit 3882f51

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

readme.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ The purpose of this application was to create a simple project based on Laravel
1616
- Includes PHPUnit tests. Placed in `tests/ConverterTest.php` and run by typing `vendor/bin/phpunit`
1717
- Project structure was made using Laravel installer
1818

19-
#### Frontend
19+
### Frontend
20+
2021
The theme is built using gulp, elixir ans scss. It's designed with simplicity in mind. Blade templates are split into multiple files.
2122

2223
### Use Case
@@ -26,6 +27,13 @@ The theme is built using gulp, elixir ans scss. It's designed with simplicity in
2627
- Support numbers between 0 and 3999, only numeric characters
2728
- Display history of converted numbers along with creation time
2829

30+
### Installation
31+
32+
- Recommended development environment is [Homestead](https://laravel.com/docs/5.2/homestead)
33+
- `.env` file is required. You can copy `.env.example` (the one used by me)
34+
- `npm install` for required dependencies
35+
- `php artisan migrate` to create the database
36+
2937
### Important custom files
3038

3139
- `app/Http/routes.php`

0 commit comments

Comments
 (0)