Skip to content

Commit 9b405fc

Browse files
committed
Add README.md
1 parent c30d5cb commit 9b405fc

File tree

1 file changed

+173
-2
lines changed

1 file changed

+173
-2
lines changed

README.md

Lines changed: 173 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,174 @@
1-
https://sanajitjana.github.io
1+
# Sanajit Jana's Personal Website
22

3-
My Personal portfolio
3+
[![Hugo](https://img.shields.io/badge/Hugo-0.120+-blue.svg)](https://gohugo.io/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![GitHub Pages](https://img.shields.io/badge/Hosted%20on-GitHub%20Pages-blue.svg)](https://sanajitjana.github.io/)
6+
7+
## 🌟 Overview
8+
9+
Welcome to my personal portfolio and blog website! This site showcases my journey as a Full Stack Software Developer specializing in Java, Spring Boot, and Microservices. I build scalable and high-performance web applications using technologies like MySQL, PostgreSQL, Kafka, Docker, and AWS.
10+
11+
The website features a clean, modern design powered by Hugo and the Hugo Narrow theme, with sections dedicated to my work experience, projects, and technical blog posts covering various topics in software development.
12+
13+
**Live Site:** [https://sanajitjana.github.io/](https://sanajitjana.github.io/)
14+
15+
## ✨ Features
16+
17+
- **Responsive Design**: Optimized for all devices with a mobile-first approach
18+
- **Dark/Light Mode**: Built-in theme switcher with multiple color schemes
19+
- **Fast Performance**: Static site generation with Hugo for blazing-fast load times
20+
- **SEO Optimized**: Meta tags, structured data, and search engine friendly
21+
- **Blog Section**: Technical posts on modern development topics including:
22+
- Hugo and Static Site Generation
23+
- React Hooks and Frontend Development
24+
- AWS Cloud Computing
25+
- Docker and Containerization
26+
- DevOps and CI/CD Pipelines
27+
- Microservices Architecture
28+
- Database Design and SQL Optimization
29+
- API Design and RESTful Services
30+
- Cybersecurity and Secure Coding
31+
- Machine Learning Fundamentals
32+
- Mobile App Development with React Native
33+
- **Portfolio Sections**: Work experience and personal projects showcase
34+
- **Social Integration**: LinkedIn, GitHub, and email contact links
35+
- **PWA Ready**: Progressive Web App manifest for app-like experience
36+
- **Accessibility**: WCAG compliant design and navigation
37+
38+
## 🛠️ Tech Stack
39+
40+
- **Static Site Generator**: [Hugo](https://gohugo.io/) (v0.120+)
41+
- **Theme**: [Hugo Narrow](https://github.com/tom2almighty/hugo-narrow) (submodule)
42+
- **Content**: Markdown with Goldmark extensions
43+
- **Styling**: CSS with multiple theme variants
44+
- **JavaScript**: Vanilla JS for interactive features
45+
- **Icons**: Custom SVG icon set
46+
- **Deployment**: GitHub Pages
47+
- **Version Control**: Git with GitHub
48+
49+
## 🚀 Getting Started
50+
51+
### Prerequisites
52+
53+
Before you begin, ensure you have the following installed:
54+
55+
- **Hugo Extended** (v0.120 or later): [Installation Guide](https://gohugo.io/getting-started/installing/)
56+
- **Git**: For cloning and version control
57+
- **Go** (optional): For Hugo development
58+
59+
### Installation
60+
61+
1. **Clone the repository:**
62+
```bash
63+
git clone https://github.com/sanajitjana/sanajitjana.github.io.git
64+
cd sanajitjana.github.io
65+
```
66+
67+
2. **Initialize submodules** (for the Hugo Narrow theme):
68+
```bash
69+
git submodule update --init --recursive
70+
```
71+
72+
3. **Install dependencies** (if any):
73+
```bash
74+
# No additional dependencies required for basic Hugo sites
75+
```
76+
77+
## 🏗️ Building and Running Locally
78+
79+
1. **Start the development server:**
80+
```bash
81+
hugo server -D
82+
```
83+
84+
2. **Open your browser** and navigate to `http://localhost:1313/`
85+
86+
3. **Build for production:**
87+
```bash
88+
hugo --minify
89+
```
90+
91+
The generated static files will be in the `public/` directory.
92+
93+
### Development Commands
94+
95+
- `hugo server`: Start development server with live reload
96+
- `hugo server -D`: Include draft content in development
97+
- `hugo --minify`: Build optimized production files
98+
- `hugo --gc`: Build with garbage collection for smaller output
99+
100+
## 📝 Content Management
101+
102+
### Adding Blog Posts
103+
104+
1. Create a new Markdown file in `content/posts/`:
105+
```bash
106+
hugo new posts/your-post-title.md
107+
```
108+
109+
2. Edit the front matter and content in the generated file
110+
111+
### Adding Pages
112+
113+
1. Create content files in `content/` directory
114+
2. Use archetypes for consistent front matter: `hugo new your-page.md`
115+
116+
### Custom Layouts
117+
118+
- Modify layouts in `layouts/` directory
119+
- Override theme layouts by placing files in corresponding paths
120+
121+
## 🚀 Deployment
122+
123+
This site is automatically deployed to GitHub Pages using GitHub Actions.
124+
125+
### Manual Deployment
126+
127+
1. **Build the site:**
128+
```bash
129+
hugo --minify
130+
```
131+
132+
2. **Deploy to GitHub Pages:**
133+
- Push the `public/` directory contents to the `gh-pages` branch, or
134+
- Use GitHub Actions for automated deployment
135+
136+
### GitHub Pages Setup
137+
138+
The repository includes:
139+
- `.nojekyll` file to bypass Jekyll processing
140+
- GitHub Actions workflow for automated builds (if configured)
141+
142+
## 🤝 Contributing
143+
144+
While this is primarily a personal portfolio site, contributions for bug fixes, improvements, or feature suggestions are welcome!
145+
146+
1. Fork the repository
147+
2. Create a feature branch: `git checkout -b feature/amazing-feature`
148+
3. Commit your changes: `git commit -m 'Add amazing feature'`
149+
4. Push to the branch: `git push origin feature/amazing-feature`
150+
5. Open a Pull Request
151+
152+
## 📄 License
153+
154+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
155+
156+
**Content License**: Blog posts and articles are licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
157+
158+
## 📞 Contact
159+
160+
**Sanajit Jana**
161+
- **Email**: sanajitjana01@gmail.com
162+
- **LinkedIn**: [linkedin.com/in/sanajitjana01](https://linkedin.com/in/sanajitjana01)
163+
- **GitHub**: [github.com/sanajitjana](https://github.com/sanajitjana)
164+
- **Website**: [https://sanajitjana.github.io/](https://sanajitjana.github.io/)
165+
166+
## 🙏 Acknowledgments
167+
168+
- **Hugo Narrow Theme**: Thanks to the creators of the beautiful Hugo Narrow theme
169+
- **Hugo Community**: For the amazing static site generator
170+
- **Open Source**: All the libraries and tools that make this possible
171+
172+
---
173+
174+
*Built with ❤️ using Hugo and hosted on GitHub Pages*

0 commit comments

Comments
 (0)