Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vijaykv5/unigram
A closed platform for students to share ideas, with authentication, chat, posts, and admin dashboard.
https://github.com/vijaykv5/unigram
Last synced: 15 days ago
JSON representation
A closed platform for students to share ideas, with authentication, chat, posts, and admin dashboard.
- Host: GitHub
- URL: https://github.com/vijaykv5/unigram
- Owner: Vijaykv5
- Created: 2024-04-11T09:24:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-02T14:53:44.000Z (6 months ago)
- Last Synced: 2024-10-10T19:31:21.147Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://unigram-students.vercel.app/
- Size: 453 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UNIGRAM
A closed platform for college students to share their thoughts, ideas, and projects. It includes features such as User Authentication, Real-time chats, posts and a Admin Dashboard for managing posts and channels.
## Users
https://github.com/Vijaykv5/Unigram/assets/94985341/158917b7-385f-4d2c-acb2-690f46a1d08c
## Admin
https://github.com/Vijaykv5/Unigram/assets/94985341/e3b69a31-6545-45ae-87c4-b18c586d235a
## Installation Guide
### Requirements
- [Nodejs](https://nodejs.org/en/download)
- [Mongodb](https://www.mongodb.com/docs/manual/administration/install-community/)
Both should be installed and make sure mongodb is running.
### Installation
Fork this repo : https://github.com/Vijaykv5/Unigram
#### First Method
```shell
git clone https://github.com/your-user-name/Unigram
cd Unigram
```
Now Create an env file .env for your Mongodb String
```shell
cd server
export MONGODB_URL=""
cd ..
```
Now install the dependencies
```shell
cd client
npm install
cd ..
cd server
npm install
```
We are almost done, Now just start the development server.
For Frontend.
```shell
cd client
npm start
```
For Backend.
Open another terminal in folder, Also make sure mongodb is running in background.
```shell
cd server
npm start
```
Done! Now open localhost:5173 in your browser.
You can see your frontend running sucessfully!
#### Second Method
- This method requires docker and docker-compose to be installed in your system.
- Make sure you are in the root of your project and run the following command.
```shell
docker compose build --no-cache
```
after the build is complete run the containers using the following command
```shell
docker compose up
```
now open localhost:5173 in your browser.
# Contributions are welcome!
Please create and work over the issues if you would love to contribute to this project.
Happy coding ⭐