Skip to content

Commit 967b29c

Browse files
committed
merge master of github into master
2 parents f2d7640 + ae8091b commit 967b29c

File tree

1 file changed

+75
-18
lines changed

1 file changed

+75
-18
lines changed

README.md

Lines changed: 75 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,81 @@
1-
# trello-clone
1+
<h1 align="center">
2+
:clipboard: Vue Trello Clone :clipboard:
3+
</h1>
24

3-
## Project setup
4-
```
5-
yarn install
6-
```
5+
<h4 align="center">
6+
A Web Application that users can create and manage their tasks, designed to be similar to the famous <a href="https://trello.com">Trello</a> application
7+
</h4>
78

8-
### Compiles and hot-reloads for development
9-
```
10-
yarn serve
11-
```
9+
<p align="center">
10+
<img alt="Repo's top language" src="https://img.shields.io/static/v1?label=Main%20technology&message=Vue.js&style=for-the-badge&color=24B36B&labelColor=000000">
11+
<img alt="Repository size" src="https://img.shields.io/static/v1?label=Repo%20size&message=0.8%20MB&style=for-the-badge&color=24B36B&labelColor=000000">
12+
</p>
1213

13-
### Compiles and minifies for production
14-
```
15-
yarn build
16-
```
14+
<p align="center">
15+
<a href="#technologies">Used Technologies</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
16+
<a href="#objective">The project's objective</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
17+
<a href="#final-result">Final Result</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
18+
<a href="#how-to-use">How to Run</a>
19+
</p>
1720

18-
### Lints and fixes files
19-
```
20-
yarn lint
21+
<p align="center">
22+
<img width="750" src="screenshots/1.png" /> <br>
23+
<a href="https://vue-trello-clone20.netlify.app/" target="_blank">
24+
<img alt="Demo on Netlify" src="https://res.cloudinary.com/lukemorales/image/upload/v1563043495/readme_logos/demo_on_netlify_bbuvjz.png">
25+
</a>
26+
</p>
27+
28+
<h2 id="techonologies" name="technologies">
29+
:rocket: Used Technologies
30+
</h2>
31+
32+
- [Vue.js](https://br.vuejs.org) to build all the app in general
33+
- [Sweet Alert](https://sweetalert.js.org/) to give the user friendlier alerts
34+
- [Vue Smooth Dnd](https://kutlugsahin.github.io/vue-smooth-dnd/#/cards) to build the drag and drop feature
35+
- [Sass](https://sass-lang.com/) to style the app
36+
37+
38+
39+
<h2 id="objective" name="objective">
40+
:dart: The project's objective
41+
</h2>
42+
43+
The aim of this project was practicing Vue.js and also learning how drag and drop works and how to do it with Vue.js, I really enjoyed developing it and liked the final result!
44+
45+
<h2 id="final-result" name="final-result">
46+
:clipboard: Final Result
47+
</h2>
48+
49+
### [You can check the app running clicking here](https://vue-trello-clone20.netlify.app/)
50+
51+
<h2 id="how-to-use" name="how-to-use">
52+
:information_source: How to Run
53+
</h2>
54+
55+
Follow the steps below to run the application on your computed, first of all, you'll need to have these tools installed on your computer: Git, Node.js, Yarn and the Vue-CLI<br>
56+
If you have all of these tools installed on your computer, just follow the steps below:
57+
58+
```bash
59+
# Clone the repository in some directory of your computer
60+
$ git clone https://github.com/TiagoDiass/vue-trello-clone.git
61+
62+
# Enter in the repository
63+
$ cd vue-trello-clone
64+
65+
# Install the dependencies
66+
$ yarn install
67+
68+
# Start the app
69+
$ yarn start
2170
```
2271

23-
### Customize configuration
24-
See [Configuration Reference](https://cli.vuejs.org/config/).
72+
After following these steps, the terminal will show you in which port it's running, it's on the port 8080 usually, so, you'll just need to enter in your browser and
73+
type `localhost:8080`, then you'll see the app running. When you want to stop it, go to the terminal that you used to start the app, and type <kbd>CTRL</kbd>+<kbd>C</kbd>,
74+
this way you'll stop the app
75+
76+
---
77+
78+
Hope you enjoyed this project :smiley:<br>
79+
:wave: [Get in touch!](https://www.linkedin.com/in/tiagodiass)
80+
81+
### Author: [Tiago Dias](https://tiagodiass.github.io)

0 commit comments

Comments
 (0)