Topaz

A configurable, easy to maintain personal website

Live example: https://naresh1318.com

After working on a project the last thing I usually think of is updating my personal website. Adding links, images, description and pushing changes to the server every single time I work on something new is kinda boring especially if you are lazy like me. What do we do when we're lazy? we automate things. Thereby giving us time to, idk, complain about our laziness. I designed Topaz to automatically update as much of my website as possible.

Recent updates:

• Added ability to write and publish blogs
• Revamped home, project and blpg pages

Here's what it can currently do:

1. Automatically fetch public repos from your github account

Projects from github

2. Admin page that lets you easily add blogs and publication details

Add blogs and publications details

3. Choose what gets shown

Manage what gets shown

4. Ability to modify/write content using markdown

5. Customize website by editing theme.json file

{
  "name": "Naresh Nagabushan",
  "profile_picture_url": "https://files.naresh1318.com/public/Me/IMG_2831_low.jpg",
  "nav_bar_footer": {
      "github": {
        "link": "https://github.com/Naresh1318",
        "icon": "fa-github"
      },
      "medium": {
        "link": "https://medium.com/@rnaresh.n",
        "icon": "fa-medium"
      },
      "linkedin": {
        "link": "https://www.linkedin.com/in/naresh-nagabushan-2946b013a",
        "icon": "fa-linkedin"
      },
      "twitter": {
        "link": "https://twitter.com/Naresh_Reddy_",
        "icon": "fa-twitter"
      }
  }
}

6. Mobile friendly (currently working on this)

Mobile friendly

Here are the things that I'm still working on:

• Ability to publish and write blogs using markdown

Install

Super easy as always. Clone before you start!

1. Edit data/theme.json file to reflect what you want. Here's another example:

{
  "name": "Naresh Nagabushan",
  "profile_picture_url": "https://files.naresh1318.com/public/Me/IMG_2831_low.jpg",
  "nav_bar_footer": {
      "github": {
        "link": "https://github.com/Naresh1318",
        "icon": "fa-github"
      },
      "medium": {
        "link": "https://medium.com/@rnaresh.n",
        "icon": "fa-medium"
      },
      "linkedin": {
        "link": "https://www.linkedin.com/in/naresh-nagabushan-2946b013a",
        "icon": "fa-linkedin"
      },
      "twitter": {
        "link": "https://twitter.com/Naresh_Reddy_",
        "icon": "fa-twitter"
      }
  }
}

2. Generate a github token by visiting this link: https://github.com/settings/tokens and select the repo checkbox. Give it a name if you want and copy the token.

3. cd into the project root dir and paste the key into a keys.txt file

echo "token <your key>" >> keys.txt

**Note: ** Do not ignore the "token " prefix

4. Install docker if you don't have it already using this link: https://docs.docker.com/install

5. Add an admin account

   • Modify Dockerfile under project root:

        ENV USERNAME "<username>"
        ENV PASSWORD "<password>"
     

6. Build your image:

   docker build -t <image name>:<tag> .
   

   Here's how mine looks:

   docker build -t topaz:latest .
   

7. Run your image:

   docker run -p <port to forward>:5000 -v absolute path to data dir in project:/app/data/ <image name>:<tag>
   

   Here's mine:

   docker run -p 4000:5000 -v /home/naresh/Projects/Topaz/data/:/app/data/ topaz:latest
   
   

8. Finally, go to localhost:<port forwarded to> on your browser

9. You can access the login page using localhost:<port forwarded to>/login. Example localhost:4000/login. Login using the username and password you setup earlier.

Note: You could also modify the docker-compose.yml file to install topaz

Concluding thoughts

1. Feel free to do a pull request if you fix bugs
2. Email me [email protected] if you have any suggestions!