Scully Starter - Recipes

This is a Scully starter project for a recipes website. It's configured to pull recipes data from Flotiq and can be easily deployed to your cloud hosting - Heroku, Netlify, etc.

Live Demo: https://competent-visvesvaraya-bb732c.netlify.app/

Screenshot

This project was generated with Angular CLI version 11.0.2.

Quick start

1. Clone project

   git clone https://github.com/flotiq/scully-recipes-starter

2. Setup "Recipe" Content Type in Flotiq

   Create your Flotiq.com account. Next, create the Recipe Content Type:

   

   Note: You can also create Recipe using Flotiq REST API.

3. Configure application

   The next step is to configure our application to know from where it has to fetch the data.

   In src/environments/environment.prod.ts and in src/environments/environment.js change YOUR_FLOTIQ_API_KEY to Read only Flotiq API key.

   If you wish to import example data into your account change YOUR_FLOTIQ_API_KEY on line 17 in .flotiq/importExample.js to Read and write API KEY.

   Remember to change them back to YOUR_FLOTIQ_API_KEY before committing code to repository.

   You have to also change SNIPCART_API_KEY to your Snipcart public API KEY in src/environments/environment.prod.ts and in src/environments/environment.js to enable cart functionality.

4. Start developing

       cd scully-recipes-starter/
       npm install

   If you wish to import example recipes to your account run:

       node ./.flotiq/importExample.js

   It will add 10 images and 4 recipes to your Flotiq account.

   Note: You need to put your Read and write API key in src/environments/environment.js for import to work. You don't need Recipe content type in your account. If you already have recipes with ids recipe-1, recipe-2 they will be overwritten.

   Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

   If you wish to add new elements to the project run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

   Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

   To build the static version with Scully run:

   npm run build --prod
   npm run scully -- --scanRoutes
   npm run scully serve

   This will start the Scully static server on http://localhost:1668/

5. Manage your recipes using Flotiq editor

   You can now easily manage your recipes using Flotiq editor

   

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help with Angular

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Deploy

You can deploy this project to Netlify in 3 minutes:

Collaborating

If you wish to talk with us about this project, feel free to hop on our .

If you found a bug, please report it in issues.