https://github.com/settivishal/zine
Zine is a digital journaling platform designed to offer users an intuitive and feature-rich journaling experience. The platform focuses on enhancing creativity, collaboration, and security, making it a versatile tool for maintaining personal records and sharing meaningful moments
https://github.com/settivishal/zine
css cypress gin go golang javascript jest jwt reactjs
Last synced: 4 months ago
JSON representation
Zine is a digital journaling platform designed to offer users an intuitive and feature-rich journaling experience. The platform focuses on enhancing creativity, collaboration, and security, making it a versatile tool for maintaining personal records and sharing meaningful moments
- Host: GitHub
- URL: https://github.com/settivishal/zine
- Owner: settivishal
- Created: 2025-01-20T23:21:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-28T02:27:58.000Z (over 1 year ago)
- Last Synced: 2025-03-28T03:25:20.861Z (over 1 year ago)
- Topics: css, cypress, gin, go, golang, javascript, jest, jwt, reactjs
- Language: Go
- Homepage:
- Size: 128 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zine - The Smart Journal Platform
## Project Description
Zine is a digital journaling platform designed to offer users an intuitive and feature-rich journaling experience. The platform focuses on enhancing creativity, collaboration, and security, making it a versatile tool for maintaining personal records and sharing meaningful moments.
## Key Features
**Rich Media Support:**
Zine allows users to create engaging journal entries by incorporating various media types including text, emojis, videos & audio recordings, and images. This feature ensures that users can document their thoughts and experiences in dynamic and versatile ways.
**Calendar Integration:**
The platform includes an intuitive calendar system, enabling users to easily navigate and select specific dates for their journal entries. This feature helps users maintain a chronological record of their activities and reflections.
**Social Sharing:**
Zine provides an option for users to share their journal entries with others within the platform. This fosters a sense of community and encourages meaningful interaction among users.
**Secure Login:**
To prioritize user security and ensure a seamless login experience, the platform supports authentication via OAuth. This method provides a reliable and user-friendly way to access the application.
**Efficient Storage:**
Journal entries are stored in an object storage system or an equivalent alternative to ensure scalability, reliability, and efficient data management. This approach supports the secure and long-term storage of user-generated content.
## Tech Stack
### Frontend
- **Framework**: Next.js (React)
- **Styling**: Tailwind CSS
- **Real-time Collaboration**: LiveBlocks
- **Testing**: Jest, Cypress
- **Containerization**: Docker
### Backend
- **Language**: Go (Golang)
- **Database**: MongoDB (NoSQL)
- **Authentication**: JWT, OAuth 2.0
- **Storage**: AWS S3 (or alternative)
- **API Documentation**: Swagger
- **Containerization**: Docker
## Installation
```bash
# Clone the repository
git clone https://github.com/settivishal/Zine.git
# Frontend setup
cd frontend
npm install
npm run dev
# Backend setup
cd ../backend
go mod download
go mod tidy
go build
go run main.go
```
## Team Members
Vishal Karthikeyan Setti
GatorID - 47670880
Github Link - https://github.com/settivishal
Contribution - Backend
Jaiharishan Arunagiri Veerakumar
GatorID - 62333614
Github Link - https://github.com/Jaiharishan
Contributoin - Backend
Sravani Garapati
GatorID - 11936780
Github Link - https://github.com/Sravani2018
Contribution - Frontend
Shiva Kumar Thummanapalli
GatorID - 95344477
Github Link - https://github.com/shivarao18
Contribution - Frontend