https://github.com/khadeshyam/socially
A social media platform for communication, sharing, and networking, connecting people worldwide.
https://github.com/khadeshyam/socially
docker-compose express github-actions mysql react-query reactjs
Last synced: 3 months ago
JSON representation
A social media platform for communication, sharing, and networking, connecting people worldwide.
- Host: GitHub
- URL: https://github.com/khadeshyam/socially
- Owner: khadeshyam
- License: agpl-3.0
- Created: 2023-05-22T13:38:24.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-27T10:19:06.000Z (over 1 year ago)
- Last Synced: 2025-04-02T17:51:41.106Z (over 1 year ago)
- Topics: docker-compose, express, github-actions, mysql, react-query, reactjs
- Language: JavaScript
- Homepage: https://socially-k2tq.onrender.com
- Size: 1.74 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Socially
[](https://reactjs.org/)
[](https://expressjs.com/)
[](https://www.docker.com/)
[](https://nodejs.org/)
[](https://www.docker.com/)
## Features
- Users can Register and Login
- Create and edit posts
- Like and comment on posts
- Follow and unfollow users
- See a feed of posts
- 1-1 chat
- Infinite scrolling of posts
## Prerequisites
To run Socially locally, you need to have the following
- **[Node.js](https://nodejs.org/)** (>= v18.12.1)
- **[Aiven](https://console.aiven.io/signup?referral_code=tnz1kigcmz56dei7gbut)** (free account for MySQL)
- **[Cloudinary](https://cloudinary.com/)** (free account)
- **[Docker Desktop](https://www.docker.com/)** (>= v20.10.23) (optional)
**Note:** Cloudinary is a cloud-based image and video management platform that Socially uses to store and deliver images and videos. You can create a free Cloudinary account to get started.
## 🚀 Run using Node.js and MySQL
### 1. Clone the repository:
```bash
git clone https://github.com/khadeshyam/Socially.git
```
### 2. Navigate to the project's root directory.
```bash
cd Socially
```
### 3. Configuration of Environment Variables
To configure the environment variables for your project, follow these steps:
1. **Copy Environment Variable Template:**
- Begin by making a duplicate of the `env.example` file provided in the project repository.
- Rename the copied file to `.env`.
2. **Obtain Credentials:**
- Retrieve the necessary credentials from the following services:
- Cloudinary
- Aiven.io (MySQL DBs)
- Firebase
- Your Email Provider
3. **Update Environment Variables:**
- Open the newly created `.env` file in a text editor.
- Populate the file with the respective credentials obtained from the services mentioned above.
### 4. Install Dependencies
To install all project dependencies, use the following command in your terminal:
- Using Yarn:
```bash
yarn
```
- Using npm:
```bash
npm i
```
### 5. Run the application in development mode
- Run this script
```bash
npm run dev
```
**Navigate to http://localhost:3000 in your web browser to view the application**
## 💻 Technologies Used
- React
- Chakra UI
- Node.js
- MySQL
- Express
- Docker
## 🤝 Contributing
Contributions to the project are always welcome. If you find any bugs or want to suggest new features, please open an issue or create a pull request.
✨ Happy coding!