Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avaterclasher/vichar
Vichar, a platform to share your thoughts.
https://github.com/avaterclasher/vichar
Last synced: 28 days ago
JSON representation
Vichar, a platform to share your thoughts.
- Host: GitHub
- URL: https://github.com/avaterclasher/vichar
- Owner: AvaterClasher
- License: mit
- Created: 2024-11-19T20:41:53.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-23T01:43:57.000Z (30 days ago)
- Last Synced: 2024-11-23T02:25:04.088Z (30 days ago)
- Language: TypeScript
- Homepage: https://vichar2.vercel.app/
- Size: 359 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Vichar
**Vichar** is a complete platform for managing and interacting with user-authored posts. It comprises a **backend service** for authentication, authorization, and CRUD operations, and a **frontend interface** for users to explore, write, and manage posts. Built with scalability and modern best practices in mind, Vichar offers seamless integration between its frontend and backend components.
> **Note**: There is a hosted frontend version of the app available at [Vichar-frontend](https://vichar2.vercel.app/) and a hosted backend available at [Vichar-backend](https://vichar-qf8u.onrender.com/api-docs). But as the backend is hosted on a free render server, it may take some time to load the data.
## Table of Contents
1. [Features](#features)
2. [Repositories](#repositories)
3. [Getting Started](#getting-started)
4. [Architecture](#architecture)
5. [License](#license)
6. [Contact](#contact)
## Features
### Backend
- User authentication and JWT-based authorization.
- RESTful APIs for CRUD operations on posts.
- Database integration with PostgreSQL using Sequelize.
- Relational data handling (Users and Posts).
- Dockerized setup for development and deployment.
For detailed backend documentation, visit the [Vichar Backend README](./backend/README.md).
### Frontend
- A responsive UI built with Next.js 14 and React Server Components.
- Dynamic routing for blogs using slugs.
- Authentication and role-based access for user actions.
- Blog editor and dashboard for managing posts.
- Support for dark mode and reusable UI components.
For detailed frontend documentation, visit the [Vichar Frontend README](./frontend/README.md).
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/)
- [npm](https://www.npmjs.com/)
- [Docker](https://www.docker.com/) (optional for backend database)
### Setup Instructions
1. Clone the repository:
```bash
git clone https://github.com/AvaterClasher/vichar.git
cd vichar
```
2. **Run Backend**:
- Navigate to the `backend/` directory:
```bash
cd backend
```
- Follow the instructions in the [Backend README](./backend/README.md).
3. **Run Frontend**:
- Navigate to the `frontend/` directory:
```bash
cd frontend
```
- Follow the instructions in the [Frontend README](./frontend/README.md).
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
For queries or suggestions, feel free to reach out via [GitHub](https://github.com/AvaterClasher) or [Linkedin](https://linkedin.com/in/soumyadip-moni).