Home

Welcome to the karngyan.com wiki!

Instructions to make it your own

Recommended way [more like easiest and quickest way]

1. Fork the project.
2. Clone your copy.
3. Choose your favorite editor and open the project.
4. 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

4. Edit karngyan.config.js to your liking. You can turn on and off sections/pages by changing the enabled value for respective objects.
   • You can add your images to static directory. It matches to root when deployed.
   • Update the strings object accordingly.
5. To enable comments and likes on blog posts and project posts, we use Firebase. If you don't need that, set firebase.enabled = false in karngyan.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.
6. 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.
7. Write your blogs in content/posts and projects in content/projects in markdown or html. There's a couple of samples that come with the template.
8. 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

You can also set up forestry to never open code and use a cool editor. I'll add instructions to use that later.

Other Deployment Options

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.