Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoangsonww/post-analyzer-webserver
📋 Welcome to the Post Viewer and Analyzer: Effortlessly manage, analyze, and create posts with our intuitive web platform. Fetch posts, analyze character frequencies, and enjoy insightful visualizations—all in one place!
https://github.com/hoangsonww/post-analyzer-webserver
backend character-frequencies framework full-stack-web-development fullstack fullstack-development go golang golang-application post-analyzer
Last synced: 2 months ago
JSON representation
📋 Welcome to the Post Viewer and Analyzer: Effortlessly manage, analyze, and create posts with our intuitive web platform. Fetch posts, analyze character frequencies, and enjoy insightful visualizations—all in one place!
- Host: GitHub
- URL: https://github.com/hoangsonww/post-analyzer-webserver
- Owner: hoangsonww
- License: mit
- Created: 2024-05-19T01:19:31.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-10-16T03:54:14.000Z (3 months ago)
- Last Synced: 2024-10-17T19:01:35.504Z (3 months ago)
- Topics: backend, character-frequencies, framework, full-stack-web-development, fullstack, fullstack-development, go, golang, golang-application, post-analyzer
- Language: Go
- Homepage: https://hoangsonww.github.io/Post-Analyzer-Webserver/
- Size: 310 KB
- Stars: 13
- Watchers: 11
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Post Viewer and Analyzer with Go
## Introduction
The Post Viewer and Analyzer is a *very* simple web-based application built with Go. It serves a web interface that allows users to fetch posts from the JSONPlaceholder API, save these posts to a file, and perform a character frequency analysis on the saved data. This application demonstrates the use of Go for server-side web development, including handling HTTP requests, processing JSON, and rendering HTML templates.
## Features
- **Fetch Data**: Users can fetch posts from the external JSONPlaceholder API.
- **Save Data**: Automatically saves fetched posts into a local JSON file.
- **Analyze Data**: Performs a character frequency analysis on the contents of the saved JSON file.
- **Web Interface**: Simple and user-friendly web interface to interact with the application.
## Technology Stack
- **Go**: All server-side logic is implemented in Go, utilizing its standard library for web server functionality, file I/O, and concurrency.
- **HTML/CSS**: Front-end layout and styling.
- **JSONPlaceholder API**: External REST API used for fetching sample post data.
## Getting Started
### Prerequisites
- Go (version 1.14 or higher recommended)
- Internet connection (for fetching data from the external API)
- Web browser (for accessing the application)
### Installation
1. **Clone the repository:**
```
git clone https://github.com/hoangsonww/Post-Analyzer-Webserver.git
cd Post-Analyzer-Webserver
```
2. **Run the application:**
```
go run main.go
```
### Usage
1. **Run the application using the steps mentioned above, do not forget to run `go run main.go`!**
2. **Open your web browser.**
3. **Navigate to `http://localhost:8080/` to access the application.**
4. **Use the following endpoints to interact with the application:**
- **Home Page**: `/`
- **Fetch Posts**: `/fetch` - Fetches posts from the JSONPlaceholder and saves them to a local file.
- **Analyze Character Frequency**: `/analyze` - Analyzes the frequency of each character in the saved posts.
- **Add Post**: `/add` - Adds a new post to the saved posts.
5. Because it is currently a Backend-focus application, you can greatly enhanced it by adding a polished Frontend to it, such as by using React.js.
## Application Structure
- **main.go**: Contains all the server-side logic including API calls, concurrency handling, file operations, and web server setup.
- **home.html**: HTML template file used for rendering the web interface.
- **go.mod**: Go module file that defines the project's dependencies.
- **posts.json**: Local JSON file used to store the fetched posts.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Son Nguyen - [https://github.com/hoangsonww](https://github.com/hoangsonww)
## Acknowledgements
- [Go](https://golang.org/)
- [JSONPlaceholder](https://jsonplaceholder.typicode.com/)
---
---
Created with ❤️ by [Son Nguyen](https://github.com/hoangsonww) in 2024.