pragativerma18 / snippet-share

This is a snippet sharing app that can be used to share snippets of code and more.

 

       

Snippet-Share

This is a code snippet sharing app that lets you share syntax highlighted code snippets with easy copy paste options and a secure secret code and a unique url.

You can view the demo here.

Tech Stack 👨‍💻

• Frontend: HTML/CSS/Bulma CSS
• Backend: Django

Open Source Contests 👇

• STUDENT CODE IN

Student Code-in is a global program that helps students grow with “OPEN SOURCE”. It is a 2 months long Open-Source initiative which provides you the best platform to improve your skills and abilities by contributing to vast variety of OPEN SOURCE Projects. In this,all the registered participants would get an exquisite opportunity to interact with the mentors and the Organizing Team.

NOTE: All the contributions to be counted under Student Code-In should be made to the sci branch.

• NWoC NJACK WINTER OF CODE

NWoC (NJACK Winter of Code) is a program by NJACK (The Official Computer Science Club of IIT Patna) that helps students understand the paradigm of Open Source contribution and gives them real world software development experience.

NOTE: All the contributions to be counted under NWoC should be made to the nwoc branch.

• Script Winter of Code(SWOC)

Script Winter of Code is an open-source program envisioned by the Script Foundation. It aims to bring students into the world of open source development and see the power of unified problem-solving in real time.They will learn the skills essential in the world of programming, all the while developing a deep appreciation for the world of open-source.

Mentors

GitHub Usernames	Domain
@abhishek2x	Full Stack + Documentation
@adad20	Full Stack
@khannakshat7	Full Stack
@PragatiVerma18	Full Stack + Documentation

Quick Start 👇

• Fork and Clone the repo using

git clone https://github.com/PragatiVerma18/Snippet-Share.git
cd Snippet-Share/snippet_share_project

• Install dependencies using

pip install -r requirements.txt

• Make migrations using

python manage.py makemigrations

• Migrate Database

python manage.py migrate

• Create a superuser

python manage.py createsuperuser

• Run server using

python manage.py runserver

Issues 🔎

TITLE	LEVEL
UI Enhancements	EASY
Project Documentation	EASY
Code Themes	MEDIUM
Public and Private Modes for Sharing Snippets	HARD
Hashing/Encryption for safe sharing	ADVANCED
Rest API	HARD

Useful Resources 📚

• Django Docs
• Bulma Docs
• Django Rest Framework Docs
• Git and GitHub

Project Admin 👩‍💻

Pragati Verma

Need help? Feel free to contact me @ [email protected]

Like This?? Star ⭐ this Repo.

Made By Pragati Verma with ❤️

Pragati Verma © 2020

---

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Pragati Verma 💻

Manshi Todi 💻

Divy1998 💻

Abhishek Srivastava 💻

Akshat Khanna 💻

Aditya Tomar 💻

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

snippet-share's Issues

Add code themes

Add an option to choose between various code themes.

Please refer to this link to explore various code themes offered by Prism CSS and JS.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to SCI branch only, contributions to master branch would not be accepted.

Google authentication for login

@PragatiVerma18 please assign this task for me! I will add google authentication in the login page which will make easy for the login using one button click

Make Rest APIs

Create APIs to get / post data i.e. code snippets along with required details.

Recommended to use Django Rest Framework.

Tasks to Do:

• Define the JSON structure of the data

• Create GET / POST routes

• Provide a Postman collection to test the APIs

You can also use Heroku/AWS/GCP/Azure. Please ask for approval first.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to the SCI branch only, contributions to the master branch would not be accepted.

Mobile version layout

@PragatiVerma18 I found a bug on the mobile version of the app.

If you could provide me the file location I would love to help contribute in this project. I request you to kindly consider my request and give me an opportunity to contribute. Much thanks :)

Build A Static Stie for the documentation

Contributors Image In Readme

I think it is a great feature to add contributors image in README file. It really motivate to contributors. It is dynamically order the contributors.

If you want to this feature on README so I want to do this issue !! 😄

Add contributing.md file

Is your feature request related to a problem? Please describe.
Sometimes its confusing about how to get started with open source and contribute in a project as a beginer.

Describe the solution you'd like
Add contributing.md file which contains tutorial to make pull request from scratch, general guidelines for contribution, and some rules.

Describe alternatives you've considered
Updating README.md but it looks very chaotic

Additional context
Can I work on this feature?

Delete snippet button

Is your feature request related to a problem? Please describe.
Authenticated users can delete their own old code if needed
Describe the solution you'd like
I can implement the solution in Django as I have already worked on many similar projects.

Please assign me this task and label it for NJACK Winter of Code .

invalid username also get accpeted

SIGN UP with USERNAME (eg ".", " /", "< ") is getting ACCEPTED
there should be some CRITERIA OF VALID USERNAME

Code of Conduct

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A code of conduct file is missing
So can I work on it @9916103020

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[DOCS] All styles should be in seperate file

Problem:
All styles are in the HTML file itself. It is not a good practice to write a style in an HTML file. There should be a separate file for all styles and link that style to your HTML file would be a better option.

Solution:
Make a separate stylesheet file for all styles and link that to the HTML file.

add code_of_conduct.md file to repository.

• I would like to add a code_of_conduct.md file to the repository.

Display logo of the programming language on the sidebar

Is your feature request related to a problem? Please describe.
On the sidebar I can't find out what language the snippet is in until I click on it.


Describe the solution you'd like
I can add all the icons to the the static folder:

{% static 'img/iconfolder/{{i.lang}}/{{i.lang}}.svg' %}

Describe alternatives you've considered

I can use something like https://devicon.dev/ to display the icon:

• Flaw:: This won't work for ever language because the naming of the language from the models doesn't match the icon name
  • Ex: models.py -> html != devicon -> html5

<i class="devicon-{{i.lang|lower}}-plain">&nbsp; &nbsp;</i>

Additional context
How the alternative solution will look like:

Sign Up

Describe the bug
When we open sign up page and without filling any fields click on submit the page throws an unexpected behaviour.
Important Point to note the error is only in the deployed version, not the Master Branch version.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'the deployed version'
2. Click on 'sign up page'
3. Scroll down to 'submit without filling any fields'
4. See error

Expected behavior
A message asking to fill the fields.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• Windows
• Chrome
• 10

Smartphone (please complete the following information):

• Samsung Galaxy
• Android
• Chrome
• A20

Security Issue

Explanation of Problem

Whenever any individual clicks submit button without filling any details it throws an error of which screenshot is below.

If you all found this bug important then assign me it also:)

Syntax Highlighting dropdown not showing selected language

Describe the bug
Syntax Highlighting dropdown is not showing selected language

To Reproduce
Steps to reproduce the behavior:

1. Go to 'new snip'
2. Click on 'syntax highlight' dropdown
3. Select any language
4. Selected language is not shown

Expected behavior
Selected language should be shown
Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: Windows 10
• Browser: chrome
• Version: 87

Assign it to me and label it for NJACK Winter of Code.

Updating readme by adding SWOC program and some gifs

Hovering effect to the sign up and log in buttons

As of now, there is no hovering effect on sign up and login buttons. I want to style them by giving transformations to make them look good. Please assign this issue to me @PragatiVerma18 Mam.

Project Documentation

Create documentation/report for Snippet-Share

The documentation should include:

• Objective
• Requirements( Tech Stack Used)
• Workflow
• Implementation
• Screenshots
• Future Scope
• Conclusion

Make contributions as a markdown file, add necessary images and other references. The participants of student code in can also contribute a wiki.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to the SCI branch only, contributions to the master branch would not be accepted.

Hashing/Encryption for safe sharing

Generate Unique URLs for each code snippet by a user.

Please refer to these links for reference:

• https://github.com/Sikilabs/django-unique
• https://keyerror.com/blog/automatically-generating-unique-slugs-in-django

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to the SCI branch only, contributions to the master branch would not be accepted.

Add an open in Gitpod button in readme.

Add an open in Gitpod button in the readme.

Please refer to the following link for more details.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to the SCI branch only, contributions to the master branch would not be accepted.

Improvise and Login and Logout Page.

improve login and logout page make them more interactive.

DEBUG is set to True for Production server

Describe the bug

Django apps should not be deployed with DEBUG=True and SECRET_KEY should be taken from an enviornment variable.

To Reproduce
Steps to reproduce the behavior:
Any error on the production server will trigger this. For instance reproducing issue #38 will trigger the same.

Expected behavior
Even if something breaks in prodcution (which is very common for side projects), you would idealy want to show a custom page or something, even configuring nginx will give you a default page for the same.

Screenshots
Refer to issue #38

Desktop (please complete the following information):

• OS: All
• Browser: All

Smartphone (please complete the following information):

• Device: All
• OS: All
• Browser: All

Docker Support

Is your feature request related to a problem? Please describe.
This is feature request not associated with a problem but as an enhancement

Describe the solution you'd like
I would like to add docker support so that developers can continuously test and develop
This will also simplify hosting process.

Add Public and Private Modes for Sharing Code Snippets.

Add Public and Private Modes for Sharing Code Snippets.

Please refer to this link for refernce.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to the SCI branch only, contributions to the master branch would not be accepted.

UI Enhancements

Prerequisites

• I am running the latest version
• I checked the readme and found no answer
• I checked to make sure that this issue has not already been filed

Explanation of Problem

The current UI is rather simple. Help improve the UI /UX and make it look and work better.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to SCI branch only, contributions to master branch would not be accepted.

add contributing.md file to repository.

• I would like to add a contributing.md file to the repository.

Welcome to Student Code-In 2020

Hello,

Thanks for showing your interest in Student Code-In.
Super glad to know that you're interested in contributing to Snippet-Share.

STUDENT CODE IN

Student Code-in is a global program that helps students grow with “OPEN SOURCE”. It is a 2 months long Open-Source initiative that provides you the best platform to improve your skills and abilities by contributing to a vast variety of OPEN SOURCE Projects. In this,all the registered participants would get an exquisite opportunity to interact with the mentors and the Organizing Team.

Feel free to ask your doubts here. I recommend you go through the open issues and have an idea about the project. There will be more first-timers issues opened by us soon. You can also explore and suggest new features and report bugs. Happy Hacking!!

Regards,
Pragati Verma
Project Admin

Search option not working

Describe the bug
The search snippet option is not working

Assign the task to me and label it for NJACK Winter of Code .

Welcome bot integration

Hello there,
I can add a welcome bot config file having a proper message that will show up when any user will open up an issue or pull-request for the first time as a part of SWOC.
For reference, kindly check out: https://github.com/apps/welcome

Creating a 'Deploy to Heroku' Button

The ‘Deploy to Heroku’ button enables users to deploy apps to Heroku without leaving the web browser and with little or no configuration. The button is ideal for a quick and easy way to deploy and configure a Heroku app. The button is well-suited for use in README files and is intended to serve as a replacement to a list of manual steps typically required to configure an app.

Refer to this link for easy to follow steps.

Student Code-In

• Please add the label SCI for issues that are made during Student Code-In and are meant for SCI participants only.
• Please make a PR to the SCI branch only, contributions to the master branch would not be accepted.

issue when selecting C++ language

Whenever selecting CPP as my language and writing code and submitting it. After looking at the highlighted text you can see in above that it is showing language as C and not C++. I have attached a screenshot to this below to make it more understandable.

Now, in the above image, you can clearly see that the code is written in C++ but it is showing C as the language. Also, assign me this issue.

Hamburger menu/navigation drawer is not working

Describe the bug
Hey, It seems like an interesting project but there are some bugs on the site. When I click on the hamburger menu it doesn't come up.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
   https://snip-share.herokuapp.com/ and minimize the window.
2. Click on '....'
   Hamburger menu icon/side menu icon.
3. Scroll down to '....'
4. See error
   It doesn't open.

Expected behavior
The side menu/ navigation drawer should open on clicking the icon.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS] Windows 10 64 bit
• Browser [e.g. chrome, safari] Brave
• Version [e.g. 22] V1.19.88

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Error Occurs While Submiting Snip

Describe the bug
Your Github Repository Of Snippet-Share Project Has Some Error.
This is One Of Them If We Submit Our Form/Snip And Again We Create New Snip But Here We Select Again Same Syntax Highlighting Then Here An Error occurs Which is MultiValueDictKeyErrpr. I can easily solve it if you assign me.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'https://snip-share.herokuapp.com/'
2. Click on 'Submit After Filling Snip Details'
3. Again Submit With Same Syntax Highlighting
4. See an error

Expected behavior
After Error Occurs We Can't be able to Create New Snip.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: Windows 10
• Browser Chrome
• Version 87.0.4280.141

Additional context
Some Times Snip DoesNotExist Error Occurs.

Set Up discussion feature for great conversion.

@PragatiVerma18 mam , Did you see new feature on github ? We can set discussion on this repo. So what you have to do is just click this block in setting section of your repo. It's Amazing I guess. Have a try.

One more thing there is one mind blowing event Github Universe is running. You must watch those events.