Dark themed, SEO friendly: Nuxt Content + TailwindCSS + Firebase + i18n based SPA for procrastinating developers to quickly spin up their own kickass blog and showcase their projects.
Visit: template.karngyan.com to see all feature enabled version of this template.
Table of Contents
- Fork the project.
- Clone your copy and create your own branch out of it.
# clone just one branch, there's a lot of sh*t on others :P
# replace <username> with your username
git clone -b template --single-branch [email protected]:<username>/karngyan.com.git
git checkout -b website
- Choose your favorite editor and open the project.
- Local development setup:
# install node <= 14 and yarn (highly recommended)
$ npm install --global yarn
# cd into your project and install the dependencies
$ yarn install
# run the dev server
$ yarn dev
# open localhost:3000
Page might not load right now, you can set
firebase.enabled = false
inkarngyan.config.js
for now. Read along.
- Edit
karngyan.config.js
to your liking. You can turn on and off sections/pages by changing theenabled
value for respective objects.- You can add your images to
static
directory. It matches to root when deployed. - Update the
strings
object accordingly.
- You can add your images to
- To enable comments and likes on blog posts and project posts, we use Firebase.
If you don't need that, set
firebase.enabled = false
inkarngyan.config.js
, and move to the next step. Otherwise follow these:-
Create a firebase project.
-
Create a web app and get the firebase config object. (You can follow this video)
-
Enable Authorization (Google Provider supported as of now)
-
Enable Firestore
-
Set the following cloud firestore rules, so that your database is write protected:
rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { match /{document=**} { allow write: if request.auth != null; allow read: if true; } } }
-
Only if you'll be testing locally
- Create a copy of
.env.example
->.env
and add values from config object.
- Create a copy of
-
- Deploy to netlify using the following config:
- Repository: Your forked repository
- Publish Directory:
dist
- Build Command:
yarn generate
- Don't forget to add all the environment variables if you have enabled firebase.
- Write your blogs in
content/posts
and projects incontent/projects
in markdown or html. There's a couple of samples that come with the template. - Add to staging, Commit and Push.
The code is yours, edit whatever you feel like. Don't forget to star the repository if you liked it.
This project uses nuxt content, you can read about it here
I have set fleek to You can also set up forestry to never open code and use a cool editor. I'll add instructions to use that later.
My own website karngyan.com is actually deployed on AWS in an S3 bucket, with Cloudfront. But that comes with a few caveats to configure and maintain. Anyways the gulpfile.js to deploy to AWS is committed with the project if you feel like you want to check it out.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Raise a PR when your website's up to add you here.
Distributed under the MIT License. See LICENSE
for more information.
Karn - @gyankarn - [email protected]
For detailed explanation on how things work, check out Nuxt.js docs.