Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/farnam-hs/personal-blog
A practical web-based project built using Java Servlets, JSP, Tomcat and file-based repositories. This project helps improve backend web development skills through real-world application design.
https://github.com/farnam-hs/personal-blog
filesystem java json jsp maven servlet tomcat webapp
Last synced: 7 days ago
JSON representation
A practical web-based project built using Java Servlets, JSP, Tomcat and file-based repositories. This project helps improve backend web development skills through real-world application design.
- Host: GitHub
- URL: https://github.com/farnam-hs/personal-blog
- Owner: Farnam-Hs
- Created: 2024-09-05T17:09:03.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T10:07:26.000Z (about 2 months ago)
- Last Synced: 2024-10-31T09:13:25.427Z (7 days ago)
- Topics: filesystem, java, json, jsp, maven, servlet, tomcat, webapp
- Language: Java
- Homepage:
- Size: 3.52 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# Personal Blog
---
## 🎯 Overview
This project is a web-based personal blog application built using Java Servlets, JSP, and Tomcat. It allows users to browse articles and provides an admin interface to add, edit, or delete blog posts. All articles are stored as JSON files in the filesystem.
The image below illustrates the application design.
---
## ✨ Features
- **View Articles:** Browse and read articles on the blog that their publishing date is today or earlier.
- **Admin Section:** Add, edit, and delete blog posts through the admin interface.
- **Article Management:** Articles are stored in JSON format, and basic file operations (CRUD) are performed via Java code.
- **Basic Authentication:** Admin section is protected with basic authentication for security.
- **Responsive UI:** The UI is styled with CSS and provides a clean and user-friendly interface.
---
## 🖼️ Screenshots
**Home Page**
**Article Page**
**Login Page**
**Admin Page**
**New Article Page**
**Edit Article Page**
---
## 🛠️ Technologies Used
- Java 17
- Servlets 5.0 (Jakarta)
- JSP (Jakarta Server Pages) & JSTL (Jakarta Standard Tag Library) 3.0
- Google Gson 2.11 (Handling JSON files)
- Apache Tomcat 10.1
- Maven 3.8.5
---
## 🚀 How to Run
### 1. Clone the repository
```bash
git clone https://github.com/Farnam-Hs/Personal-Blog.git
cd Personal-Blog
```
### 2. Build the Project
Use Maven to build the project:
```bash
mvn clean install
```
### 3. Deploy to Tomcat
Add the project to your Tomcat server in your IDE or manually.
### 4. Start Tomcat:
Start the Tomcat server
### 5. Access the Application
Open a web browser and navigate to:
```http://localhost:8080/[Context-Path]``` or ```http://localhost:8080/[Context-Path]/home```
---
## 📘 Usage Example
**1. Viewing Articles:**
- On the home page, all blog articles will be listed. Click on a title to view the full article.
**2. Admin Actions:**
- Navigate to the admin section using the designated admin URL ```/admin``` or click on the ```Login``` button.
- Login with the correct credentials to access admin actions. (Username: ```admin``` | Password: ```admin```)
**3. CRUD Operations:**
- **Add New Article:** Click on the ```+``` button in the admin section, fill in the article title, choose the publishing date, write the content, and ```Publish```.
- **Edit Article:** Click on the ```Edit``` button next to an article in the admin section, modify the title, content, or the publishing date and ```Update```.
- **Delete Article:** Click the ```Delete``` button in the admin section to remove an article.
---
## ⚠️ Error Handling
- **Unauthorized Access (403):** Attempting to access restricted URLs will result in a 403 Forbidden error.
- **Not Found (404):** : Accessing non-existent pages or malformed URLs will result in a 404 Not Found error.
- **Internal Server Error (500):** If an unexpected issue occurs on the server (e.g., failure in file operations or processing), a 500 Internal Server Error will be shown to the user.
---
Sample solution for the [Personal Blog](https://roadmap.sh/projects/personal-blog) challenge from [roadmap.sh](https://roadmap.sh/).