⚠️ IMPORTANT NOTICE: Please refrain from deleting any elements within this README.md file that contain emojis.

---

🚨 Backend Code: SourceCode\backend\colabTeam_web | Frontend Code: SourceCode\frontend

A collaboration web app built on top of Django framework.

This README.md is a base template, and updates will be made in the future.

Feel free to use this as a starting point for your project.

📷 Images • 📖 Guide • Packages • 💾 How To Fork • Download • 👤 Contributors • Related • License

📷 Images

Password Reset Email

📖 Guide

All Guide files locations.

• README.md
  • CoLab-Team-inDevelopment/README.md
• Backend Setup
  • CoLab-Team-inDevelopment/backend/SETUP.md
• Figma design files
  • CoLab-Team-inDevelopment/frontend/UI_Design/UI.md
• Frontend React code
  • CoLab-Team-inDevelopment/frontend/colab_team_frontend/FRONTEND_CODE.md

Environment

Preferable environment management options:

• Python's built-in venv
• MiniConda or Conda

Packages

Key packages and their versions currently in use:

• Python: 3.10.13
• Django: 4.2.6

💾 How To Fork

1. Fork the Repository:

   • Click the "Fork" button in the top right corner of the page. This will create a copy (a fork) of the repository under your GitHub account.

2. Clone the Forked Repository:

   • On your forked repository, click the "Code" button and copy the repository URL (e.g., https://github.com/yourusername/repository.git).
   • Open your terminal or command prompt and navigate to the directory where you want to clone the repository.
   • Run the following command to clone the repository to your local machine( Replace URL with your ):

     git clone https://github.com/yourusername/repository.git
     

3. Create a New Branch:

   • Change to the repository directory:

     cd repository
     

   • Create a new branch with your github username for your contribution:

     git checkout -b your-username
     

   Merge will not be accepted unless branch name is your username.

4. Make Changes:

   • Make the necessary changes to the code, documentation, or any other files in your local repository.

5. Commit Changes:

   • Add the changes to the staging area:

     git add .
     

   • Commit the changes with a descriptive message:

     git commit -m "Your descriptive commit message"
     

6. Push Changes:

   • Push your changes to your forked repository on GitHub:

     git push origin your-branch-name
     

7. Create a Pull Request (PR):

   • Go to your forked repository on GitHub.
   • Click on the "Compare & pull request" button next to the branch you just pushed.
   • Provide a descriptive title and description for your pull request, outlining the changes you made.
   • Click on the "Create pull request" button.

8. Review and Merge:

   • The repository maintainers will review your pull request, suggest changes, or approve and merge it into the main repository.

Remember to communicate with the repository maintainers and follow any guidelines or contributing rules they may have specified in their repository's README or CONTRIBUTING file.

👤 Contributors

Thanks go to these wonderful people (emoji key):

• AlphaDarkmoon
• SiddhantTotade
• arunim-io
• so on... [ Team members are recommended to add their own Github name. ]

This project follows the all-contributors specification. Contributions of any kind are welcome!

Emailware

Markdownify is an emailware. Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at [email protected] about anything you'd want to say about this software. I'd really appreciate it!

Credits

This software uses the following open source packages:

• Electron
• Node.js
• Marked - a markdown parser
• showdown
• CodeMirror
• Emojis are taken from here
• highlight.js

Related

markdownify-web - Web version of Markdownify

Support

Or

License

New BSD License 🪪

Copyright <2023> <CoLab Team>

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---

CoLab Team  ·  GitHub @CoLab-Team-Developers