https://github.com/imkkingshuk/feed0
https://github.com/imkkingshuk/feed0
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/imkkingshuk/feed0
- Owner: ImKKingshuk
- License: gpl-3.0
- Created: 2023-08-22T10:07:13.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T19:28:10.000Z (about 2 years ago)
- Last Synced: 2024-12-31T10:42:43.150Z (10 months ago)
- Language: JavaScript
- Size: 202 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Feed0: Empowering Student Voices
Version- v1.1
Date- 15th August,2023
Next Update- Soon (Forums UI, Comments, Likes, Share, User Profile )
Live Demo
Feed0 is a dynamic social media application tailored exclusively for students in educational institutions. Built using cutting-edge technologies like React, Node.js, and MongoDB, Feed0 provides a secure and anonymous space for students to express their opinions, discuss grievances, and engage in meaningful conversations, while ensuring their privacy. Join us in fostering a vibrant community where students can share, connect, and contribute to a positive educational experience.
Follow these steps to run Feed0
#### Installation
Install dependencies for both the frontend & backend:
```bash
npm run install:all
```
##### Start the backend and frontend servers concurrently :
```bash
npm start
```
##### Only Start the frontend:
```bash
npm run start:frontend
```
##### Only Start the backend:
```bash
npm run start:backend
```
Contributing
We welcome contributions from the community to make Feed0 better for everyone. Whether you're a developer, designer, or enthusiast, there are ways you can contribute.
### Getting Started
1. **Fork the Repository:** Start by forking the repository to your GitHub account.
2. **Clone your Fork::** Clone the forked repository to your local machine using the following command:
```bash
git clone https://github.com/ImKKingshuk/Feed0.git
```
3. **Install dependencies:** Install dependencies for both the frontend & backend:
```bash
npm run install:all
```
### Making Contributions
1. **Create a New Branch:** Create a new branch for your contributions:
```bash
git checkout -b yourbranch/your-feature-name
```
2. **Always Sync Repo:** Before starting any work, sync your local repository with the upstream (original) repository to ensure you have the latest changes:
```bash
git fetch upstream
git checkout main
git merge upstream/main
```
3. **Code Changes:** Make the necessary code changes, improvements, or bug fixes in your branch.
4. **Testing:** Ensure that your changes are thoroughly tested. Run tests if applicable and make sure existing tests pass.
5. **Commit Changes:** Commit your changes with a clear and descriptive commit message:
```bash
git commit -m "Add feature: your-feature-name"
```
6. **Stay Updated To Avoid Conflicts::** While working on your feature, it's a good practice to frequently pull the latest changes from the upstream repository to avoid conflicts:
```bash
git pull upstream main
```
7. **Push your changes to your forked repository on GitHub::**
```bash
git push origin yourbranch/your-feature-name
```
8. **Create a Pull Request:** Open a pull request from your fork to the main repository. Provide a detailed description of your changes, why they are needed, and any relevant information.
😊 Thank You, We appreciate your contributions 😊