Giter VIP home page Giter VIP logo

curatedstack-nocode-template's Introduction

CuratedStack Nocode Template

MIT medium: sandoche Twitter: sandochee

๐Ÿ“‘ Free & open-source template to create a curated directory of websites without (or with) code

screenshot


๐Ÿ’ก Features

CuratedStack Nocode Template comes with pre-installed features and options:

  • ๐Ÿ“‹ List all your favorite websites by category
  • ๐Ÿ™…๐Ÿป No-code friendly using Netlify CMS (check the below tutorial)
  • ๐Ÿ”Ž Search bar and index generated automatically (using Lunr.js)
  • ๐ŸŒ“ Automatic dark theme
  • ๐Ÿš€ Floating Prompt (for Product Hunt or anything else)
  • ๐Ÿ“ˆ Google Analytics (gtag)
  • ๐Ÿ“ฑ Installable as a Progressive Web App
  • ๐Ÿ“Š Script to analyze your links & categories
  • ๐Ÿ’  Script to download websites logos automatically

โœจ Demo

Check out websites using the CuratedStack Nocode Template:

๐Ÿ“– How to use

The no-code way

Take advantage of Netlify CMS for hosting and updating your website without code. Nevertheless a few options needs to be activated in order to get started, just follow the instructions below.

  1. Add your project in Netlify using this button (and follow the steps): Deploy to Netlify

    1.1. Once done you will see the link to your website, you can later on customize your website name or even add your own domain name.

  2. Enable Identity and Git Gateway by following these instructions (full instructions here: https://www.netlifycms.org/docs/add-to-your-site/#enable-identity-and-git-gateway)

    2.1. Go to Netlify and go to your brand new deployed website, then Settings > Identity, and select Enable Identity service.

    2.2. Under Registration preferences, select Invite only.

    2.3. Click on Invite users and add your email, press Send you will receive a link by email to create an account.

  3. Go to Services > Git Gateway, and click Enable Git Gateway. This authenticates with your Git host and generates an API access token. In this case, we're leaving the Roles field blank, which means any logged in user may access the CMS.

  4. Go to your website name and add /admin at the end of the url, you will be redirected to the admin panel where you need to login with your email and password defined at step

  5. From this admin panel you will be able to change anything, name, description, logos, websites, categories, and you will have to click on "Publish" once done and wait a few minutes before it is updated!

The coders way

  1. Fork this project
  2. Edit content/config.json
  3. Add your categories in content/categories.json (after deleting the demo categories)
  4. Add your links in content/links.json (after deleting the demo links)
  5. Edit your strings in locales/en.json (optional)
  6. Change your icon in static/images/logos/icon.png
  7. Use npm run analyze to check analyze your links and npm run get-logos to try to download logos of websites (do not forget to remove the static/images/logos demo content)
  8. Generate with npm run generate
  9. Deploy the generated files from the dist folder (on netlify, gitpages or surge, they are all free)

โš™๏ธ How to run

Pre-requisites

  • NodeJS

Install

npm install

Development

npm run dev

Build

npm run generate

Analyze links & categories

# To check how many links you have in each category and if there are links in double
npm run analyze

Downloads logos

npm run get-logos

Deploy to netlify (for free)

Deploy to Netlify

๐Ÿค Contributing

Contributions, issues and feature requests are welcome!

โญ๏ธ Show your support

Please โญ๏ธ this repository if this project helped you!

patreon.png

๐Ÿบ Buy me a beer

If you like this project, feel free to donate:

  • PayPal: https://www.paypal.me/kanbanote
  • Bitcoin: 19JiNZ1LkMaz57tewqJaTg2hQWH4RgW4Yp
  • Ethereum: 0xded81fa4624e05339924355fe3504ba9587d5419
  • Monero: 43jqzMquW2q989UKSrB2YbeffhmJhbYb2Yxu289bv7pLRh4xVgMKj5yTd52iL6x1dvCYs9ERg5biHYxMjGkpSTs6S2jMyJn
  • Motive: MOTIV-25T5-SD65-V7LJ-BBWRD (Get Motive Now: https://motive.network)

curatedstack-nocode-template's People

Contributors

hussseinkizz avatar sandoche avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.