Skip to content

Commit ad93a68

Browse files
authored
Merge pull request neoighodaro-articles#3 from oreHGA/master
updated readme
2 parents 838a9fc + 6f74a3d commit ad93a68

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

README.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Building a Trello Clone using Laravel and Vue
2+
This is a demo application showing how to build a simple trello clone using Laravel and Vue. You can read about how it was created [on Pusher's blog](https://blog.pusher.com/author/neo).
3+
4+
## Getting Started
5+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
6+
7+
### Prerequisites
8+
What things you need to install the software.
9+
10+
* Git.
11+
* PHP.
12+
* Composer.
13+
* Laravel CLI.
14+
* Laravel Valet (optional).
15+
* A webserver like Nginx or Apache.
16+
* A Node Package Manager ( npm or yarn ).
17+
18+
### Install
19+
Clone the git repository on your computer
20+
```
21+
$ git clone https://github.com/neoighodaro-articles/trello-clone-vue-laravel.git
22+
```
23+
24+
You can also download the entire repository as a zip file and unpack in on your computer if you do not have git
25+
26+
After cloning the application, you need to install it's dependencies.
27+
```
28+
$ cd trello-clone-vue-laravel
29+
$ composer install
30+
```
31+
32+
### Setup
33+
- When you are done with installation, copy the `.env.example` file to `.env`
34+
```
35+
$ cp .env.example .env
36+
```
37+
38+
- Generate the application key
39+
```
40+
$ php artisan key:generate
41+
```
42+
43+
- Install Passport
44+
```
45+
$ php artisan passport:install
46+
```
47+
48+
- Add your database credentials to the necessary `env` fields
49+
50+
- Migrate the application
51+
```
52+
$ php artisan migrate
53+
```
54+
55+
- Seed Database
56+
```
57+
php artisan db:seed
58+
```
59+
60+
- Install node modules
61+
```
62+
$ npm install
63+
```
64+
65+
### Run the application
66+
```
67+
$ php artisan serve
68+
```
69+
70+
## Built With
71+
* [Laravel](https://laravel.com) - The PHP framework for building the API endpoints needed for the application
72+
* [Vue](https://vuejs.org) - The Progressive JavaScript Framework for building interactive interfaces
73+
74+
## Acknowledgments
75+
* [Laravel](https://laravel.com) - The excellent documentation explaining how to get started with Laravel and Laravel Passport made it easy to provide a step by step guide for beginners to follow the application
76+
* [Vue](https://vuejs.org) - Concise documentation

0 commit comments

Comments
 (0)