Skip to content

Commit 597dcc5

Browse files
committed
Update readMe
1 parent 0b9adaf commit 597dcc5

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,28 @@ List of technologies which are used in this project.
2525
- MySQL: Version 8
2626
- Node: Version 14.15.0
2727

28-
### Setup Environment:
29-
---
28+
### Setup Environment for Development:
3029
- Copy `.env.example` to `.env`.
3130
- Build `docker-compose build`.
32-
- Run `docker-compose up -d`.
33-
- Open favourite browser and type `http://localhost:5000`.
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.
3442
- Generate key `docker exec bakend-end php artisan key:generate`
3543
- If you want to install a npm package then run `docker exec front-end npm install <Package_Name>`.
3644
- If you want to install compose package then run `docker exec back-end compose install <PACKAGE_NAME>`.
3745

46+
47+
3848
## Contribute
39-
---
49+
4050
Contribution are alwasy welcome! Please read the [contribution guidelines](contributing.md) first.
4151
- Fork this project to your personal account.
4252
- Create your feature branch `git checkout -b feature/foo`.
@@ -45,5 +55,5 @@ Contribution are alwasy welcome! Please read the [contribution guidelines](contr
4555
- Create a new Pull Request.
4656

4757
## License
48-
---
58+
4959
The theme is available as open source under the terms of the [MIT License](LICENSE.txt).

0 commit comments

Comments
 (0)