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.
Projects from github
Add blogs and publications details
Manage what gets shown
Ability to modify/write content using markdown
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"
}
}
}
Mobile friendly
Super easy as always. Clone before you start!
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"
}
}
}
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.
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
Install docker if you don’t have it already using this link: https://docs.docker.com/install
Add an admin account
Modify Dockerfile
under project root:
ENV USERNAME "<username>"
ENV PASSWORD "<password>"
Build your image:
docker build -t <image name>:<tag> .
Here’s how mine looks:
docker build -t topaz:latest .
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:
```bash docker run -p 4000:5000 -v /home/naresh/Projects/Topaz/data/:/app/data/ topaz:latest
Finally, go to localhost:<port forwarded to>
on your browser
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