-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/AdwaithAthman/socioverse
- Loading branch information
Showing
1 changed file
with
120 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # Socioverse | ||
| Socioverse is a full-fledged social media platform built with the passion for community, clean code, and cutting-edge tech. | ||
| Developed using the powerful MERN stack (MongoDB, Express.js, React.js, and Node.js) | ||
| <br> | ||
| <a href="https://socioverse.online"><strong>Link</strong></a> | ||
|
|
||
|  | ||
|
|
||
| Socioverse empowers you to: | ||
| - Connect: Foster meaningful interactions with friends, family, and like-minded individuals through an intuitive and engaging interface. | ||
| - Create: Express yourself through captivating posts, share your thoughts and experiences, and engage in stimulating conversations. | ||
| - Discover: Uncover a world of diverse perspectives and interests - explore communities, join discussions, and expand your horizons. | ||
|
|
||
| ## Client Side Preview | ||
|  | ||
|
|
||
| ## Admin Side Preview | ||
|  | ||
|
|
||
| ## Installation | ||
| Follow these instructions to set up your development environment, which you need to do before you start contributing code to this project. | ||
|
|
||
| 1. Clone the repository: | ||
|
|
||
| ```shell | ||
| git clone https://github.com/AdwaithAthman/socioverse.git | ||
| ``` | ||
| 2. Set up the required environment variables. Rename the `.env.example` file to `.env` and provide the necessary values for your environment. | ||
|
|
||
| ## Manual Installation | ||
|
|
||
| 3. Navigate to the project directory: | ||
|
|
||
| ```shell | ||
| cd socioverse | ||
| ``` | ||
| 4. Navigate to client directory and server directory separately | ||
|
|
||
| ```shell | ||
| cd client | ||
| cd server | ||
| ``` | ||
|
|
||
| 5. Install the dependencies separately(install in both client and server) | ||
|
|
||
| ```shell | ||
| npm install | ||
| ``` | ||
| 6. Start the development server: | ||
|
|
||
| - server side | ||
| ```shell | ||
| npm run dev | ||
| ``` | ||
| - client side | ||
| ```shell | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ## Docker Installation | ||
|
|
||
| 3. Using Docker compose: | ||
| ```shell | ||
| docker-compose up | ||
| ``` | ||
|
|
||
| ## Technologies Used | ||
|
|
||
| | Stack / Feature | Technology Used | | ||
| | :---: | :---: | | ||
| | Architecture | Clean Architecture | | ||
| | Frontend | React, Redux, Tailwind CSS, Typescript | | ||
| | Backend | Node js, Express js, Typescript | | ||
| | Normal Authentication | JSON Web Token JWT | | ||
| | Google Authentication | Firebase Auth, JWT | | ||
| | Database | Mongo DB | | ||
| | Caching | Redis | | ||
| | Version control | Git | | ||
| | Image storage | Cloudinary | | ||
| | Messaging Service | Socket io | | ||
| | Mailing Service | Node Mailer | | ||
| | Video Service | Agora | | ||
| | Containerization | Docker | | ||
| | Deployed | AWS | | ||
| | Reverse Proxy | Nginx | | ||
| | CD | GitHub-Actions | | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are always welcome! There are multiple ways you can contribute: | ||
|
|
||
| ### Reporting Bugs | ||
|
|
||
| If you encounter any bugs or issues, please [open a new issue](https://github.com/AdwaithAthman/socioverse/issues/new) in this repository. | ||
| Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| If you have a suggestion that could make this project better, please [open a new issue](https://github.com/AdwaithAthman/socioverse/issues/new) in this repository. | ||
| Be sure to include a title and clear description, as much relevant information as possible, and a "Steps to Reproduce" section which indicates the steps which reproduce the new behavior. | ||
|
|
||
| ### Code Contributions | ||
|
|
||
| If you'd like to contribute code (e.g., by fixing a bug, implementing a new feature, etc.), please follow these steps: | ||
|
|
||
| 1. Fork this repository. | ||
| 2. Create a branch: `git checkout -b your-feature` | ||
| 3. Make your changes and commit them: `git commit -m 'Add your feature'` | ||
| 4. Push your changes to your forked repository: `git push origin your-feature` | ||
| 5. Open a pull request from your branch in the forked repository to the original repository. | ||
|
|
||
| Thank you for your contributions! | ||
|
|
||
| ## Contact | ||
|
|
||
| For any questions, feedback, or inquiries, please reach out to: | ||
|
|
||
| - Adwaith Athman | ||
| - Email: iamadwaith17@gmail.com | ||
| - LinkedIn: [View](https://www.linkedin.com/in/adwaith-athman/) |