* Updated readme
This commit is contained in:
27
README.md
27
README.md
@@ -1,20 +1,27 @@
|
|||||||
# full-skies-nuxt
|
# full-skies
|
||||||
|
Ce projet a pour but d'exploiter [l'API Le Système Solaire](https://api.le-systeme-solaire.net/) et de proposer une interface simple pour selectionner des favoris.
|
||||||
|
|
||||||
## Build Setup
|
- [Dependencies](#dependencies)
|
||||||
|
- [How to install](#how-to-install)
|
||||||
|
## Dependencies
|
||||||
|
* Vue.js
|
||||||
|
* Nuxt
|
||||||
|
* Axios
|
||||||
|
* Jest
|
||||||
|
|
||||||
|
## How to install
|
||||||
|
To install and run the project, you need to clone this project and run these commands in the root folder.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# install dependencies
|
# Install the npm packages
|
||||||
$ npm install
|
$ npm install
|
||||||
|
|
||||||
# serve with hot reload at localhost:3000
|
# FOR DEVELOPPERS
|
||||||
|
# Runs an instance of the app on localhost:3000 that hot reloads
|
||||||
$ npm run dev
|
$ npm run dev
|
||||||
|
|
||||||
# build for production and launch server
|
# FOR PRODUCTION
|
||||||
|
# Compiles and builds for production and starts app
|
||||||
$ npm run build
|
$ npm run build
|
||||||
$ npm run start
|
$ npm run start
|
||||||
|
|
||||||
# generate static project
|
|
||||||
$ npm run generate
|
|
||||||
```
|
```
|
||||||
|
|
||||||
For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
|
|
||||||
|
|||||||
Reference in New Issue
Block a user