Skip to content

Commit d6fadf3

Browse files
committed
update readme.
1 parent afb8cdb commit d6fadf3

File tree

3 files changed

+68
-72
lines changed

3 files changed

+68
-72
lines changed

Diff for: ProductDetails.png

233 KB
Loading

Diff for: ProductList.png

268 KB
Loading

Diff for: README.md

+68-72
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,68 @@
1-
<p align="center"><img src="https://laravel.com/assets/img/components/logo-laravel.svg"></p>
2-
3-
<p align="center">
4-
<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
5-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a>
6-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a>
7-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a>
8-
</p>
9-
10-
## About Laravel
11-
12-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
13-
14-
- [Simple, fast routing engine](https://laravel.com/docs/routing).
15-
- [Powerful dependency injection container](https://laravel.com/docs/container).
16-
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
17-
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
18-
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
19-
- [Robust background job processing](https://laravel.com/docs/queues).
20-
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
21-
22-
Laravel is accessible, powerful, and provides tools required for large, robust applications.
23-
24-
## Learning Laravel
25-
26-
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
27-
28-
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1400 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
29-
30-
## Laravel Sponsors
31-
32-
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell).
33-
34-
- **[Vehikl](https://vehikl.com/)**
35-
- **[Tighten Co.](https://tighten.co)**
36-
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
37-
- **[64 Robots](https://64robots.com)**
38-
- **[Cubet Techno Labs](https://cubettech.com)**
39-
- **[Cyber-Duck](https://cyber-duck.co.uk)**
40-
- **[British Software Development](https://www.britishsoftware.co)**
41-
- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
42-
- **[DevSquad](https://devsquad.com)**
43-
- [UserInsights](https://userinsights.com)
44-
- [Fragrantica](https://www.fragrantica.com)
45-
- [SOFTonSOFA](https://softonsofa.com/)
46-
- [User10](https://user10.com)
47-
- [Soumettre.fr](https://soumettre.fr/)
48-
- [CodeBrisk](https://codebrisk.com)
49-
- [1Forge](https://1forge.com)
50-
- [TECPRESSO](https://tecpresso.co.jp/)
51-
- [Runtime Converter](http://runtimeconverter.com/)
52-
- [WebL'Agence](https://weblagence.com/)
53-
- [Invoice Ninja](https://www.invoiceninja.com)
54-
- [iMi digital](https://www.imi-digital.de/)
55-
- [Earthlink](https://www.earthlink.ro/)
56-
- [Steadfast Collective](https://steadfastcollective.com/)
57-
- [We Are The Robots Inc.](https://watr.mx/)
58-
- [Understand.io](https://www.understand.io/)
59-
- [Abdel Elrafa](https://abdelelrafa.com)
60-
- [Hyper Host](https://hyper.host)
61-
62-
## Contributing
63-
64-
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
65-
66-
## Security Vulnerabilities
67-
68-
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
69-
70-
## License
71-
72-
The Laravel framework is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).
1+
# Docker
2+
For quick development, the Docker [Bitnami Laravel Development Container](https://github.com/bitnami/bitnami-docker-laravel) is used in the project.
3+
4+
# Local workspace
5+
- Clone the repository
6+
```
7+
$ git clone https://github.com/railsgem/laravel-vue-atdw-data.git
8+
$ cd laravel-vue-atdw-data
9+
$ cp -r .env.example .env
10+
```
11+
12+
- Then update the **ATLAS_API_KEY** in .env file, the test api key which was provided in the test documentation.
13+
14+
- Finally launch the Laravel application development environment using:
15+
```
16+
$ docker-compose up
17+
$ docker-compose exec myapp php artisan key:generate
18+
$ docker-compose exec myapp php artisan config:cache
19+
$ docker-compose exec myapp npm install
20+
$ docker-compose exec myapp npm run dev
21+
```
22+
23+
> ## Note
24+
25+
> If the application directory contained the source code of an existing Laravel application, the Bitnami Laravel Development Container would load the existing application instead of bootstrapping a new one.
26+
27+
After the artisan application server has been launched in the myapp service, visit http://localhost:3000 in your favorite web browser and you'll be greeted by the default Laravel welcome page.
28+
29+
# Executing commands
30+
31+
The general structure of the exec command is:
32+
33+
```
34+
$ docker-compose exec <service> <command>
35+
```
36+
List all artisan commands:
37+
```
38+
$ docker-compose exec myapp php artisan list
39+
```
40+
41+
# Reinitialize:
42+
Delete the file /tmp/initialized.sem and restart the container to reinitialize
43+
```
44+
$ docker-compose exec myapp rm -r /tmp/initialized.sem
45+
```
46+
47+
48+
# ScreenShots
49+
50+
![./ProductList.png](./ProductList.png)
51+
52+
![./ProductDetails.png](./ProductDetails.png)
53+
54+
# User Documentation
55+
56+
## 1. Filters
57+
By changing the Regions or Areas, the table will automatically refresh with the selection.
58+
59+
## 2. Product Details
60+
Clicking the details, the pop up dialog will show the product details in a list of attribute / value pair.
61+
62+
## 3. Infinity scroll
63+
User are able to scroll up to load a new page.
64+
65+
## 4. Content order is randomised
66+
Then content order is randomised by passing the random seed `rand_YYYY-MM-DD`.
67+
68+
## 5. Cache (Not implemented)

0 commit comments

Comments
 (0)