https://github.com/ekafyi/junglejs-netlify-functions
Starter site for JungleJS + Netlify Functions + Storybook + TailwindCSS
https://github.com/ekafyi/junglejs-netlify-functions
Last synced: 9 months ago
JSON representation
Starter site for JungleJS + Netlify Functions + Storybook + TailwindCSS
- Host: GitHub
- URL: https://github.com/ekafyi/junglejs-netlify-functions
- Owner: ekafyi
- License: mit
- Created: 2020-07-30T13:22:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-16T07:59:31.000Z (about 3 years ago)
- Last Synced: 2025-01-23T15:37:38.194Z (11 months ago)
- Language: CSS
- Homepage:
- Size: 750 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JungleJS + Netlify Functions starter site
A starter site with:
- [JungleJS](https://www.junglejs.org) — Svelte and GraphQL-based static site generator
- [Netlify Functions](https://www.netlify.com/products/functions/) — Serverless functions
- [Storybook](https://storybook.js.org) — UI development environment
- [TailwindCSS](https://tailwindcss.com) — utility-first CSS framework
Introductory posts:
- [Go serverless with this JungleJS + Netlify functions starter site](https://dev.to/ekafyi/go-serverless-with-this-junglejs-netlify-functions-starter-site-3bg0)
- [Getting Started with Netlify Functions](https://dev.to/ekafyi/getting-started-with-netlify-functions-part-1-zero-config-setup-and-writing-our-first-functions-1i5b)
## Quick start
[](https://vercel.com/import/git?s=https%3A%2F%2Fgithub.com%2Fekafyi%2Fjunglejs-netlify-functions%2Ftree%2Fmaster) [](https://app.netlify.com/start/deploy?repository=https://github.com/ekafyi/junglejs-netlify-functions)
Or [create a new repo](https://github.com/ekafyi/junglejs-netlify-functions/generate) with Github template.
## Install and develop
```bash
# Install the global Netlify CLI package if you haven’t
npm install netlify-cli -g
# Clone and go to project directory
git clone https://github.com/ekafyi/junglejs-netlify-functions.git
cd junglejs-netlify-functions
# Install dependencies
npm install
# Start Netlify Dev server
netlify dev
# (Optional) Start Storybook server in a separate tab
npm run storybook
```
Netlify Dev serves your site on `localhost:3333`. Your functions run on `localhost:3333/.netlify/functions/{YOUR_FUNCTION_NAME}`.
This starter comes with a sample function `hello.js`, which you can access on:
- localhost:3333/.netlify/functions/hello
- localhost:3333/.netlify/functions/hello?name=Eka (example with query parameter)
If you start it, Storybook runs on `localhost:6006`.
The Storybook and Tailwind setup is based on my previous starter site, https://github.com/ekafyi/junglejs-storybook-tailwind. Check out [the readme](https://github.com/ekafyi/junglejs-storybook-tailwind#directory-structure) for more details.
## Deploy
Run `npm run build`.
Your site is in the `jungle/build` directory, ready to publish anywhere that hosts static sites (Github Pages, Netlify, Vercel, any cPanel-based hosting).
### Netlify CI/CD
Deploy your project to a Github or GitLab repo.
Run `netlify init` (or `ntl init` for short) to start the continuous deployment wizard. With this setup, Netlify will automatically build every time you push to your chosen branch.
More info: https://docs.netlify.com/configure-builds/get-started
### Vercel CI/CD
(Similar feature is available on Vercel but I haven’t got round to trying it. PR welcome.)
## Credits
Boilerplate code from [Jungle template](https://github.com/junglejs/template). Repo icon/logo by [Freepik](http://www.freepik.com) from [Flaticon](https://www.flaticon.com).
---
(c) 2020 Eka MIT License