Skip to content

lucky-chap/stickly

Repository files navigation

Stickly

Features

  • React.js for Static Site Generator
  • 🔥 Type checking TypeScript
  • 💎 Styled with Tailwind CSS
  • ✅ Strict Mode for TypeScript and React 18
  • 🖱️ One click deployment with Vercel or Netlify (or manual deployment to any hosting services)
  • 🖱️ Drag and drop notes

Requirements

  • Node.js 14+ and npm

Getting started

Run the following command on your local environment:

git clone https://github.com/lucky-chap/stickly
cd stickly
npm install

Then, you can run locally in development mode with live reload:

npm run dev

Customization

You can easily configure Next js Boilerplate. Please change the following file:

  • public/apple-touch-icon.png, public/favicon.ico, public/favicon-16x16.png and public/favicon-32x32.png: your website favicon, you can generate from https://favicon.io/favicon-converter/
  • src/styles/global.css: your CSS file using Tailwind CSS
  • src/utils/AppConfig.ts: configuration file
  • src/templates/Main.tsx: default theme

Deploy to production

You can see the results locally in production mode with:

$ npm run build

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify:

Netlify Deploy button

Deploy to Vercel

Deploy this Next JS Boilerplate on Vercel in one click:

Deploy with Vercel

License

Licensed under the MIT License, Copyright © 2023

See LICENSE for more information.