This repo is the frontend for the Meme Governance dApp example. ๐
It contains:
- Landing page for your project (served on the
/
path, e.g.,http://localhost:8080/
) - dApp functionality (served on the
/dapp
path, e.g.,http://localhost:8080/dapp
) - Full integration to NeoLine browser wallet
๐ Written in Next.js, Tailwind CSS, and TypeScript โก๏ธ
Developer experience first:
- ๐ฅ Next.js for Static Site Generator
- ๐จ Integrate with Tailwind CSS
- ๐ PostCSS for processing Tailwind CSS
- ๐ Type checking TypeScript
- โ๏ธ Linter with ESLint
- ๐ Code Formatter with Prettier
- ๐ฆ SEO metadata, JSON-LD and Open Graph tags with Next SEO
- โ๏ธ Bundler Analyzer
Built-in feature from Next.js:
- โ Minify HTML & CSS
- ๐จ Live reload
- โ Cache busting
- Node.js version 12
- npm
Run the following command on your local environment:
git clone --depth=1 https://github.com/AxLabs/meme-governance-frontend.git my-project-name
cd my-project-name
npm install
Then, you can run locally in development mode with live reload:
npm run dev
Open http://localhost:8080 with your favorite browser to see your project. For your information, Next JS need to take some time to compile the project for your first time.
.
โโโ README.md # README file
โโโ public
โ โโโ assets
โ โโโ images # Image used by the template, it can be replaced by your own images
โโโ src
โ โโโ background # Atomic background component
โ โโโ button # Atomic button component
โ โโโ cta # Atomic cta component
โ โโโ feature # Atomic feature component
โ โโโ footer # Atomic footer component
โ โโโ hero # Atomic hero component
โ โโโ layout # Atomic layout component
โ โโโ navigation # Atomic navigation component
โ โโโ pages # Next JS pages includes index page
โ โโโ styles # Atomic styles component
โ โโโ templates # List of blocks components
โ โโโ utils # Atomic utils component
โโโ tailwind.config.js # Tailwind CSS configuration file
โโโ tsconfig.json # TypeScript file
You can easily configure the theme. Please change the following file:
public/apple-touch-icon.png
,public/favicon.ico
,public/favicon-16x16.png
andpublic/favicon-32x32.png
: your favicon, you can generate from https://favicon.io/favicon-converter/src/styles/main.css
: your CSS file using Tailwind CSSutils/Config.ts
: website configuration filesrc/pages/index.tsx
: the index page of the theme use theBase
componentsrc/template/Base.tsx
: theBase
component using component blockssrc/templates/*
: the list of component blockssrc/*
: other folders in src are the atomic components used by components blocks
Here is the layer:
- the entry point:
index.tsx
insrc/pages
- the
Base
template:Base.tsx
insrc/templates
- use component blocks from
src/templates/*
- use atomic components from
src/*
You can see the results locally in production mode with:
$ npm run build
$ npm run start
The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.
You can create an optimized production build with:
npm run build-prod
Now, your theme is ready to be deployed. All generated files are located at dist
folder, which you can deploy with any hosting service.
This repo is strongly based on templates provided by CreativeDesignsGuru. Thanks for it! ๐
Licensed under the MIT License.
See LICENSE for more information.
Made with โค๏ธ by AxLabs