1
0
Fork 0
mirror of https://github.com/GuerillaHQ/now-playing synced 2024-06-27 14:01:35 +00:00

Add Readme

This commit is contained in:
Tixie 2019-12-07 20:56:26 +01:00
parent c23206c02b
commit d4ad7cf8a6

55
README.md Normal file
View file

@ -0,0 +1,55 @@
# Now Playing
Handpicked Albums by the Glitch Family
## Project setup
### Install hugo
[Install Documentation](https://gohugo.io/getting-started/installing/)
### Launch dev server
```
hugo server
```
### Build for production
```
hugo --baseURL $URL
```
As it `$URL` is an env variable but you can harcode it in the build command.
## Use NetlifyCMS backoffice in local mode
This website use [NetlifyCMS](https://www.netlifycms.org/) backoffice to manage albums easily.
And it's possible to use it while working in local:
### Install JS dependencies
```
npm i
```
of if you don't want to impact the package-lock
```
npm ci
```
### Run local API
While running [developement hugo server](#launch-dev-server) launch this command in another terminal:
```
node server
```
### Admin your website in local
Go to you website's local url + `/admin` (by default it's `http://localhost:1313/admin`). Enjoy!
## Credits
* [Higgcss](https://github.com/robinparisi/higgcss) - The minimal CSS framework use as skeleton
* Wryk for the help and support 💜