ln-dev7 / sharuco Goto Github PK

View Code? Open in Web Editor NEW

93.0 1.0 23.0 5.07 MB

Share your code. Manage Form & Link.

Home Page: https://sharuco.lndev.me/

License: MIT License

TypeScript 91.92% JavaScript 7.45% CSS 0.28% Dockerfile 0.06% Makefile 0.22% Shell 0.01% SCSS 0.06%

code nextjs snippets forms shadcn-ui

sharuco's Introduction

Sharuco

Share your code. Manage Form & Link.

Features

Create snippets of your code and share / Generate images from your snippets and share on Social Network. ( https://sharuco.lndev.me/explore )
Create forms easily in minutes and collect all your information. ( https://sharuco.lndev.me/forms )
Store all the links that are useful to you and with possibilities to make everyone discover them. ( https://sharuco.lndev.me/links )

Requirements

Node (>=18.18.0 recommended) + npm
docker + docker-compose
make (for Makefile targets)

How to Install

# clone the repository and cd into it:
git clone https://github.com/ln-dev7/sharuco && cd sharuco

# Tips : make help to see all make target

## --- WITH DOCKER ---
# build and up the whole stack and start it with one command:
# note, all env are available in the example
make docker-build-up

# to build the app container only:
make docker-build

# to run the app container:
make docker-run

## --- NO DOCKER ---
# copy the .env.example to .env and fill all env variables
cp .env.example .env

#   - `NEXT_PUBLIC_FIREBASE_API_KEY`: Your Firebase API Key.
#   - `NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`: Your Firebase Auth Domain.
#   - `NEXT_PUBLIC_FIREBASE_PROJECT_ID`: Your Firebase Project ID.
#   - `NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET`: Your Firebase Storage Bucket.
#   - `NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID`: Your Firebase Messaging Sender ID.
#   - `NEXT_PUBLIC_FIREBASE_APP_ID`: Your Firebase App ID.
#   - `NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID`: Your Firebase Measurement ID.

# Install dependencies:
make install

# build and start
make build && make start

# or on dev mode
make dev

Usage

The application is accessible at http://localhost:3000/.

Contributing

Contributions are welcome! To contribute, follow these steps:

Fork the repository.
Create a branch for your contribution with git checkout -b my_new_feature.
Make your changes.
Submit a pull request on master branch.

License

This project is licensed under the MIT License.

Credits

Frontend: Next.js
DataBase / Auth: Firebase
Hosting: Vercel
UI : UI Shadcn ( Tailwind CSS + Radix UI )
Tools: React Query, React Hook Form

sharuco's People

Contributors

Stargazers

Watchers

sharuco's Issues

Expandable snippet card

Add expand icon on snippet card to have the code in fullscreen instead of scrolling horizontally.

Delete code

Possibility of deleting a code, knowing that the deletion must remove the id of the code in the favorites field of the users who have added the code in favorites.

Page the list of snippets

Allow to page the list of snippets at the exploration page level

Popular code

implement the popular code page,
The goal is to display the 30 codes that have the highest number of favorites.
This page will be available when the application already has more than 50 codes

Explore page : Filter by language (or Tag)

IDE integration

I would be also useful to have sharuco integration in IDE like vscode. Developers can simply select code snippet and share directly from their code editor

Add the possibility to edit the information of its code, knowing that if it changes the isPrivate from true to false it must lose all the favorites that the code has had and all the users who have bookmarked this code, in their favorites field we must remove the id of this code

Improving Project Efficiency with Guidelines and Templates

By adding these following; 👇🏾

Contribution Guidelines: Establishing clear guidelines for contributions can help standardize the process and ensure that all contributors are following the same conventions. This could include coding conventions, issue tracking, pull request workflows, and other relevant information.

Code of Conduct: Adding a code of conduct to the project can help create a safe and welcoming environment for all contributors. The code of conduct can outline expectations for behavior, provide guidelines for reporting and handling conflicts, and help establish a positive and inclusive community.

Issue Templates: Creating templates for submitting issues can help guide users in providing clear and concise information. This could include sections for issue titles, descriptions, steps to reproduce, and any other relevant information.

Pull Request Templates: Creating templates for submitting pull requests can help ensure that contributors include all the necessary information in their requests. This could include sections for a description of the changes made, any potential impacts, and any relevant links or references.

Explore page codes not readable

The content of the code blocs on explore page is not adapted to the blocs' width, and that makes the user slide to see the full content, spoiling the user experience.

Icons shrink

The header profile icon is stretched on mobile

Device: iphone 7 plus

Optimise favoris button

Adding favourites is slow

Feature request: Possibility to see the date when the code was added

Hey, thank you very much for Sharuco. Very nice concept. I just tried it out, and I thought it might be interesting for the users to see when a code has been added. This will be especially helpful when sometimes, the syntax has changed in a language, making some codes obsolete...

The github gist guide page can't be fetch

Reproduce error:

Open sharuco main page and sign in
Go to your dashboard and Try to add a new code
When the message (You cannot publish code on your Github Gist because you have not yet followed this guide.) click on the word "guide" highlight

Add icon for any language in the Card

Search code

Implement the possibility to search a code according to the description and according to the language, the search must be available on the pages "/explore" , "/dashboard" , "/user-id"

Please use SearchCode component ( /components/search-code.tsx )

Sharing link og-image are not working on twitter

Description
After sharing a link on twitter the og-image doesn't display.

Add a new language on the app

add the new languuage on constants/languages.js

Got this message sometimes when getting back to the app

UX improvements

Add and "Click Away Listener" for some popup or dailog modal who need it for a better ux. For example, once the link has been copied, it would be interesting if the popup closed directly, I also find it important that the user closes this popup by clicking elsewhere

Here, we have successfully modified his code but the user still has to click on "Cancel" to close the form, I think it should close automatically after the success of the operation.

Here, we have successfully added a code but the form is still present, I think it should close automatically. If the idea is to allow multiple codes to be added, I suggest adding a checkbox to ask the user if he wants to leave the form open.