Skip to content

Commit 8d96ea3

Browse files
committed
Update Read Me
1 parent 7791793 commit 8d96ea3

File tree

1 file changed

+39
-35
lines changed

1 file changed

+39
-35
lines changed

README.md

+39-35
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,62 @@
22

33
This project `laravel+Vuejs` is based on `docker and docker-compose`
44

5-
65
# <span style="color:#007bff"> Table of content </span>
76

8-
- [Prerequisites](#Prerequisites)
9-
- [Technologies](#Technologies)
10-
- [Setup Environment](#Setup-Environment)
11-
- [License](#License)
12-
- [Contribute]
7+
- [Prerequisites](#Prerequisites)
8+
- [Technologies](#Technologies)
9+
- [Setup Environment](#Setup-Environment)
10+
- [License](#License)
11+
- [Contribute]
1312

1413
## Prerequisites
14+
1515
---
16+
1617
Make sure you have insalled the following prerequisites in your development or production machine.
1718

18-
- `Docker` - [Download & install Docker](https://docs.docker.com/get-docker/) make sure that the latest docker version has been installed on your machine.
19+
- `Docker` - [Download & install Docker](https://docs.docker.com/get-docker/) make sure that the latest docker version has been installed on your machine.
1920

2021
### Technologies
22+
2123
---
24+
2225
List of technologies which are used in this project.
23-
- PHP : Version 7.3
24-
- Laravel: Version 8.x
25-
- MySQL: Version 8
26-
- Node: Version 14.15.0
26+
27+
- PHP : Version 7.3
28+
- Laravel: Version 8.x
29+
- MySQL: Version 8
30+
- Node: Version 14.15.0
2731

2832
### Setup Environment for Development:
29-
- Copy `.env.example` to `.env`.
30-
- Build `docker-compose build`.
31-
- Run `docker-compose up -d` for development purpose.
32-
- Open favourite browser and type `http://localhost`. If you wan to run on different port, you can change the `HTTP_PORT` from `.env` file.
33-
- Generate key `docker exec bakend-end php artisan key:generate`
34-
- If you want to install a npm package then run `docker exec front-end npm install <Package_Name>`.
35-
- If you want to install compose package then run `docker exec back-end compose install <PACKAGE_NAME>`.
36-
37-
### Setup Environment for Production:
38-
- Copy `.env.example` to `.env`.
39-
- Change the necessary staff in `.env` file.
40-
- Run `docker-compose -f docker-compose.production.yml up` for production.
41-
- Open favourite browser and type `http://localhost`. If you wan to run on different port, you can change the `HTTP_PORT` from `.env` file.
42-
- Generate key `docker exec bakend-end php artisan key:generate`
43-
- If you want to install a npm package then run `docker exec front-end npm install <Package_Name>`.
44-
- If you want to install compose package then run `docker exec back-end compose install <PACKAGE_NAME>`.
45-
46-
33+
34+
- Copy `.env.example` to `.env`.
35+
- Build `docker-compose build`.
36+
- Run `docker-compose up -d` for development purpose.
37+
- Open favourite browser and type `http://localhost`. If you wan to run on different port, you can change the `HTTP_PORT` from `.env` file.
38+
- Generate key `docker exec bakend-end php artisan key:generate`
39+
- If you want to install a npm package then run `docker exec front-end npm install <Package_Name>`.
40+
- If you want to install compose package then run `docker exec back-end compose install <PACKAGE_NAME>`.
41+
42+
### Setup Environment for Production:
43+
44+
- Copy `.env.example` to `.env`.
45+
- Change the necessary staff in `.env` file.
46+
- Run `docker-compose -f docker-compose.production.yml up` for production.
47+
- Open favourite browser and type `http://localhost`. If you wan to run on different port, you can change the `HTTP_PORT` from `.env` file.
48+
- If you want to install a npm package then run `docker exec front-end npm install <Package_Name>`.
49+
- If you want to install compose package then run `docker exec back-end compose install <PACKAGE_NAME>`.
4750

4851
## Contribute
4952

5053
Contribution are alwasy welcome! Please read the [contribution guidelines](contributing.md) first.
51-
- Fork this project to your personal account.
52-
- Create your feature branch `git checkout -b feature/foo`.
53-
- Commit your changes `git commit -am 'Add some foo`.
54-
- Push to the branch `git push origin feature/foo`.
55-
- Create a new Pull Request.
54+
55+
- Fork this project to your personal account.
56+
- Create your feature branch `git checkout -b feature/foo`.
57+
- Commit your changes `git commit -am 'Add some foo`.
58+
- Push to the branch `git push origin feature/foo`.
59+
- Create a new Pull Request.
5660

5761
## License
5862

59-
The theme is available as open source under the terms of the [MIT License](LICENSE.txt).
63+
The theme is available as open source under the terms of the [MIT License](LICENSE.txt).

0 commit comments

Comments
 (0)