├── .github
├── ISSUE_TEMPLATE
│ ├── custom.md
│ └── feature_request.md
└── workflows
│ └── main.yml
├── .logo
├── Gitter.png
├── License.png
├── Robosoft.jpeg
├── The Robotic Forum Logo.jpg
└── sampark banner.png
├── CONTRIBUTING.md
├── LICENSE
└── Readme.md
/.github/ISSUE_TEMPLATE/custom.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Custom issue template
3 | about: Describe this issue template's purpose here.
4 | title: ''
5 | labels: ''
6 | assignees: ''
7 |
8 | ---
9 |
10 |
11 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature request
3 | about: Suggest an idea for this project
4 | title: ''
5 | labels: enhancement, good first issue
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 |
13 | **What features does our page has? **
14 | A clear and concise description of what you want to happen.
15 |
16 | **What features do we want extra?**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 |
19 | **How should you submit a pull request for this issue**
20 |
21 | **any tips for solving this issue**
22 | Add any other context or screenshots about the feature request here.
23 |
--------------------------------------------------------------------------------
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
1 | # This is a basic workflow to help you get started with Actions
2 |
3 | name: CI
4 |
5 | # Controls when the action will run.
6 | on:
7 | # Triggers the workflow on push or pull request events but only for the main branch
8 | push:
9 | branches: [ backend ]
10 | pull_request:
11 | branches: [ backend ]
12 |
13 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel
14 | jobs:
15 | # This workflow contains a single job called "build"
16 | build:
17 | # The type of runner that the job will run on
18 | runs-on: ubuntu-latest
19 |
20 | # Steps represent a sequence of tasks that will be executed as part of the job
21 | steps:
22 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
23 | - uses: actions/checkout@v2
24 | with:
25 | ref: backend
26 |
27 | # Runs a single command using the runners shell
28 | - name: Run a one-line script
29 | run: echo Building the app
30 |
31 |
32 | - uses: actions/setup-node@v2
33 | with:
34 | node-version: '12'
35 | - run: npm install
36 | deploy:
37 | runs-on: ubuntu-latest
38 | needs: build
39 | steps:
40 | - uses: actions/checkout@v2
41 | with:
42 | ref: backend
43 | - uses: akhileshns/heroku-deploy@v3.7.8
44 | with:
45 | heroku_api_key: ${{secrets.HEROKU_API_KEY}}
46 | heroku_app_name: "sampark-backend"
47 | heroku_email: ${{secrets.HEROKU_EMAIL}}"
48 |
49 |
50 |
51 |
52 |
--------------------------------------------------------------------------------
/.logo/Gitter.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/The-Robotics-Forum/sampark/1bf22ebb7d841eae1e9063a682e88d1e5a4e5a3d/.logo/Gitter.png
--------------------------------------------------------------------------------
/.logo/License.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/The-Robotics-Forum/sampark/1bf22ebb7d841eae1e9063a682e88d1e5a4e5a3d/.logo/License.png
--------------------------------------------------------------------------------
/.logo/Robosoft.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/The-Robotics-Forum/sampark/1bf22ebb7d841eae1e9063a682e88d1e5a4e5a3d/.logo/Robosoft.jpeg
--------------------------------------------------------------------------------
/.logo/The Robotic Forum Logo.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/The-Robotics-Forum/sampark/1bf22ebb7d841eae1e9063a682e88d1e5a4e5a3d/.logo/The Robotic Forum Logo.jpg
--------------------------------------------------------------------------------
/.logo/sampark banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/The-Robotics-Forum/sampark/1bf22ebb7d841eae1e9063a682e88d1e5a4e5a3d/.logo/sampark banner.png
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | ## Contribution Guidelines
2 |
3 | This is an Open Source Project. All contributions are welcome. Please follow the steps below for contributing.
4 |
5 | - To file an issue or a feature request, use the [GitHub Issue Tracker](https://github.com/The-Robotics-Forum/samparak/issues) and describe briefly what you are expecting.
6 | - To raise a Pull Request for frontend:
7 | 1. Fork the repository
8 | 2. Create a branch. Preferable name it the same as the issue you want to solve. Eg name `frontend-issue-712`.
9 | 3. Commit your changes to the new branch you created in your forked repository.
10 | 4. Raise a Pull Request to the `frontend-stage` branch of this repository.
11 | - To raise a Pull Request for backend:
12 | 1. Fork the repository
13 | 2. Create a branch. Preferable name it the same as the issue you want to solve. Eg name `backend-issue-712`.
14 | 3. Commit your changes to the new branch you created in your forked repository.
15 | 4. Raise a Pull Request to the `backend-stage` branch of this repository.
16 | - The `frontend-stage` will be merged with `frontend-master` and `backend-stage` will be merged with `backend-master` weekly on Sundays.
17 | - Each master will have its own CI integration, so that the contributors and mentors can have look at recent code in action.
18 |
19 | **Make sure to follow these guidelines**
20 | 1. Run `npm start` locally before pushing any commits or creating a Pull Request.
21 | - If `npm start` is failing locally, your Pull Request will also fail and won't be able to merge.
22 | 2. If you are taking up any issue from the issue tracker, please name your commits in this form. This will automatically link the Issue to your commit.
23 | - `Fix #{Issue Number}: Whatever change you did`
24 | - Example commit message: `Fix #9: Added a new function`
25 | 3. Give "easy to understand" names to the branches you create in your forked repository
26 | 4. While creating a Pull Request, explain in brief what changes you made.
27 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 The Robotics Forum, VIT Pune
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/Readme.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 | 
5 |
6 |
8 |
9 |
10 |
11 |
12 | 
13 |
14 |
15 |
Web Application
16 |
17 |
18 | [](https://gitter.im/The-Robotics-Forum/samparak?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
19 |
20 | ### Deployed app here:
21 | [https://sampark-frontend.herokuapp.com/](https://sampark-frontend.herokuapp.com/)
22 |
23 | ## What the Project is?
24 | Sampark is an open source team chat platform, which provides capabilies similar to slack. The Project is built using MERN Stack and Socket.io.
25 | You can find the source code for front end in frontend branch of this repo and source code for backend in branch named backend.
26 |
27 | ## What Feature does this project have?
28 | 1) User can create Public rooms or private rooms, anyone can join your public room but for joing a private room, only people who are invited cna join. When a person is invited to a private room, an email is sent about the inviation.
29 | 2) Each Room will have multiple channels, which can be used for effective communication of various topics simultaneously.
30 | 3) Users can share text messages in real time on each channel.
31 | 4) Users can share files includes (audio/video/images) as well as location and formated code snippets.
32 | 5) Backend is able to detect abuses in text messages and messages can be reported as well.
33 | 6) Each user has some points associated to him, which decreases upon using abuses or when his messages are reported.
34 | 7) If a message is reported by some number of users it will not be shown to other members.
35 | 8) Each Room will have moderator, a moderator will have powers to kick a user or make the user a moderator.
36 |
37 | ## Excited? Want to start contributing?
38 | 1) For Contributing to backend, you should be familar with basics of node.js and socket.io and you are good to go.
39 | 2) For Contributing to frontend, you should have understanding of basics of Javascript, React and Redux.
40 | 3) Join your [Gitter channel]( https://gitter.im/The-Robotics-Forum/samparak?utm_source=share-link&utm_medium=link&utm_campaign=share-link ) , to get connected with the mentors. feel free to ask us questions and even if you wnat to suggest a new feature which the platform lacks.
41 |
42 | ## Want to Contribute 🙋♂️?
43 |
44 | Awesome! If you want to contribute to this project, you're always welcome! See [Contributing Guidelines](CONTRIBUTING.md). You can also take a look at [Sampark's Project Status Tracker](https://github.com/The-Robotics-Forum/sampark/issues) for getting more information about current or upcoming tasks.
45 |
46 | ## License
47 |
48 | ```
49 | MIT License
50 |
51 | Copyright (c) 2020 The Robotics Forum, VIT Pune
52 |
53 | Permission is hereby granted, free of charge, to any person obtaining a copy
54 | of this software and associated documentation files (the "Software"), to deal
55 | in the Software without restriction, including without limitation the rights
56 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
57 | copies of the Software, and to permit persons to whom the Software is
58 | furnished to do so, subject to the following conditions:
59 |
60 | The above copyright notice and this permission notice shall be included in all
61 | copies or substantial portions of the Software.
62 |
63 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
64 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
65 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
66 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
67 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
68 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
69 | SOFTWARE.
70 | ```
71 |
--------------------------------------------------------------------------------