Skip to content

Commit 89fc550

Browse files
Update README.md
1 parent 5bd9f8f commit 89fc550

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,31 @@ Pass: ajSGenC0\
2828
To get full user account, contact me on my <a href="http://id-a.pl" target="_blank">company site</a>.
2929

3030
## Functions
31-
The application contains a mechanism for managing the database tables. After adding table support to crud, the following record operations are possible:
31+
Vue CRUD provides a set of utitlities, from which you can compose your own application. Features included in the system can communicate with each other thanks to the use of the Vuex library. Vue CRUD includes the following elements:
32+
33+
CRUD,
34+
Authentication system:
35+
login form (built-in communitation with API, validation),
36+
optional locale selection,
37+
redirecting to the app,
38+
App layuout components:
39+
Toolbar (with optional elements):
40+
title,
41+
logo,
42+
user profile,
43+
locale selection,
44+
logout,
45+
slots for developer
46+
Sidebar:
47+
List of routes,
48+
Slot for title or user avatar,
49+
Slot for developer,
50+
Customizable sidebar behaviour
51+
Alerts system,
52+
Footer,
53+
... and others
54+
55+
The CRUD is a mechanism for managing the database tables. Included CRUD system allows the following operations:
3256

3357
* Store,
3458
* Update,
@@ -66,6 +90,31 @@ Another functions and features:
6690
* language versions,
6791
* simple configuration of themes,
6892

93+
## Quick start
94+
95+
Do you want to test the application quickly, and you do not have a ready API? No problem, you can use the ready-made example in the **examples** folder. The API for this example is available on the internet, so you can connect to it by entering its address in the configuration file.
96+
97+
### Steps
98+
99+
- Select template from **examples** folder you want to use, e.g. **examples/simple-crud**. Then:
100+
- Copy **examples/simple-crud/public** folder to the root directory,
101+
- Copy the rest of files and folders (**config**, **locales**, **routes**, **main.js**, **router.js**) from **examples/simple-crud** folder to the **src** directory,
102+
- If you have your own API prepared, modify **src/config/api.js** file,
103+
- Type following commands:
104+
105+
``` console
106+
yarn
107+
:: or
108+
npm install
109+
```
110+
and then:
111+
``` console
112+
yarn serve
113+
:: or
114+
npm run serve
115+
```
116+
... and your app is already running (probably at http://localhost:8080).
117+
69118
## API
70119
The application requires a connection with the appropriate API. API can be created in any technology - the condition is its compliance with the Vue CRUD communication specification. If you need to create your API and do not know how to get started, and you don't mind PHP and Laravel, download or clone the <a href="https://github.com/szczepanmasny/vue-crud-laravel-api" target="_blank">Vue CRUD Laravel API project</a>.
71120

0 commit comments

Comments
 (0)