Update README to explain project
This commit is contained in:
parent
4beb29331f
commit
2cfe6094c8
30
README.md
30
README.md
|
@ -1,18 +1,37 @@
|
|||
# sreed-web-programming
|
||||
Stuff for Web Programming
|
||||
|
||||
Web programming project using Vue JS to create a simple store web application.
|
||||
|
||||
[Tutorial series followed](https://www.vuemastery.com/courses/intro-to-vue-3/forms-and-v-model-vue3)
|
||||
|
||||
This project uses [Vue Single File Components](https://v3.vuejs.org/api/sfc-spec.html), which in general must be built into the project using `vue-cli`.
|
||||
|
||||
[Axios](https://github.com/axios/axios) is also used to read a static JSON file to populate reviews on the product.
|
||||
|
||||
![](./screenshot.png)
|
||||
|
||||
|
||||
## Project setup
|
||||
```
|
||||
sudo apt install npm
|
||||
|
||||
Using [NodeSource PPA on Ubuntu](https://nodesource.com/) to install latest version of `nodejs` and `npm`
|
||||
|
||||
```bash
|
||||
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
|
||||
sudo apt install nodejs
|
||||
sudo npm install -g npm
|
||||
git clone git@gitlab.com:shaunrd0/sreed-web-programming.git
|
||||
cd sreed-web-programming
|
||||
npm install
|
||||
```
|
||||
|
||||
### Compiles and hot-reloads for development
|
||||
The following instructions were (mostly) automatically generated by running `vue-cli create sreed-web-programming`.
|
||||
|
||||
### Serve Application for Development
|
||||
```
|
||||
npm run serve
|
||||
```
|
||||
|
||||
### Compiles and minifies for production
|
||||
### Compiles Application for Production
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
@ -24,3 +43,4 @@ npm run lint
|
|||
|
||||
### Customize configuration
|
||||
See [Configuration Reference](https://cli.vuejs.org/config/).
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load Diff
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
Loading…
Reference in New Issue