Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updated docs and added documentation for IWOC2.0 #173

Merged
merged 1 commit into from
Jan 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/iwoc-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/swoc-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
[![Forks](https://img.shields.io/github/forks/sanchitbajaj02/palettegram?color=greendark)](https://github.com/Sanchitbajaj02/palettegram/network/members)
[![Stars](https://img.shields.io/github/stars/sanchitbajaj02/palettegram?color=greendark)](https://github.com/Sanchitbajaj02/palettegram/stargazers)


## 🏆 Featured in:

<table>
Expand All @@ -22,6 +21,12 @@
<th>Event Name</th>
<th>Event Description</th>
</tr>
<tr>
<td><img src=".github/assets/iwoc-banner.png" width="200" height="auto" loading="lazy" alt="Welcome to Social Winter of S4" /></td>
<td>Innogeeks Winter of Code 2024</td>
<td>Innogeeks Winter of Code is a month-long open-source program envisioned by the Innogeeks. It is an online initiative that introduces new
contributors to open-source software development. <a href="docs/iwoc.md">Click here</a> to get the guidelines. </td>
</tr>
<tr>
<td><img src=".github/assets/swoc-banner.png" width="200" height="auto" loading="lazy" alt="Welcome to Social Winter of S4" /></td>
<td>Social Winter of Code 2024</td>
Expand All @@ -36,8 +41,6 @@
</table>


<br/>

## 🤔 Why open source

Contributing in open source increases your opportunities to work with different projects and mentors, getting to know various insights and ideas. It is a platform where contributors grow together with a construvtive and a positive attitude.
Expand Down Expand Up @@ -131,7 +134,6 @@ Without the tireless efforts and dedication of these exceptional developers, Pal

<!-- _View the list of all contributors [here](https://github.com/sanchitbajaj02/palettegram/graphs/contributors)._ -->


## 🙏🏽 Support

This project needs a star️ from you. Don't forget to leave a star 🌟
5 changes: 4 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ Currently **Palettegram** is in rapid development process and it will be better

| Version | Supported |
| ------- | ------------------ |
| 1.0.5 | :white_check_mark: |
| 1.0.4 | :white_check_mark: |
| 1.0.3 | :white_check_mark: |
| 1.0.2 | :white_check_mark: |
| 1.0.1 | :white_check_mark: |
| 1.0.0 | :white_check_mark: |
| 1.0.0 | :x: |
| 0.0.0 | :x: |

## Reporting a Vulnerability
Expand Down
55 changes: 55 additions & 0 deletions docs/iwoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Innogeeks Winter of Code - Guidelines 📑

## Welcome to IWOC Please read and follow all these guidelines carefully curated by IWOC Admins

1. Participants select your project you want to contribute to from the official website and join that particular project channel in the server.

2. Connect with Project Maintainers of the project and know more about project.

3. Visit github repo of project and look for the open issues. You will see **IWOC2024** Tag with the hardness level of the issue choose accordingly.

4. Comment on issue if you want to work on it and get it assigned to yourself from Project Admins. make sure you work on a single issue at a single time don't occupy the issues unnecessarily if found strict actions will be taken.

5. Once you get the issue assigned clone the repo and start working on it. if any issues encountered contact Maintainers, they will guide you.

6. Once work is done Make a pull request mentioning all the Minor/Major details about your feature you added you can also provide the documentation it will be appreciated.

7. If Maintainers find all good they will accept your pull request and assign you the point depending on hardness of issue.

8. Till here you have successfully done a open source contribution. repeat the procedure again and again and earn more points to get top on leaderboard and earn your swags.

9. If you have any Doubts/ Questions/ Suggestions please feel free to talk to the IWOC team. Please feel free to report any malpractices found in server.

10. Staying inactive in the server or project group will lead to your disqualification without any notification.

## FAQ - Frequently Asked Question

1. **What if multiple contributors comment on the same issue?**

I'll assign the issue based on the FCFS (First Come First Serve) manner. If you create an issue, it will be assigned only to you.

2. **How long one can work on an issue?**

To ensure fairness for everyone, once an issue is assigned to you, you will have a maximum of two days to solve it and create a pull request. If you fail to create a pull request within this timeframe, the issue will be assigned to the next person who commented on the issue to work on.

3. **Can you please clarify how the PRs (pull requests) will be documented and tracked?**

Once your PR is merged it will be considered as one contribution and I'll record it at my end. All the necessary details will be recorded. Just keep on contributing and I'll take care of keeping track of your successful contributions.

4. **How many Max issues can I work on?**

There is no limit on the number of issues you can work on, but I suggest working on one issue at a time.

5. **How can I start with IWOC?**

This is one of the most frequently asked questions, Assuming you have registered for IWOC and have completed all the prerequisites like joining the Quine platform, IWOC discord server etc.

To participate in the event, please familiarize yourself with the project codebase. Advanced users can try setting up the project on their local machine. At this point, you can begin addressing the issues listed in your selected projects. Keep in mind that the process for contributing to a project may vary depending on the project and its admin.

6. **Can I contribute in more than one project?**

Yes, you can. But I'll suggest you focus on one project at a time.

7. **Where will I find all the projects of IWOC 2.0?**

Visit https://iwoc.codes/projects
6 changes: 3 additions & 3 deletions docs/swoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

2. Connect with Project Admins and Mentors of the project and know more about project.

3. Visit github repo of project and look for the open issues. You will see SWOC 2024 Tag with the hardness level of the issue choose accordingly.
3. Visit github repo of project and look for the open issues. You will see **SWOC S4** Tag with the hardness level of the issue choose accordingly.

4. Comment on issue if you want to work on it and get it assigned to yourself from Project Admins. make sure you work on a single issue at a single time don't occupy the issues unnecessarily if found strict actions will be taken.

Expand All @@ -16,7 +16,7 @@

7. If Projects Admins find all good they will accept your pull request and assign you the point depending on hardness of issue.

8. Yes till here you have successfully done a open source contribution. repeat the procedure again and again and earn more points to get top on leaderboard and earn your swags.
8. Till here you have successfully done a open source contribution. repeat the procedure again and again and earn more points to get top on leaderboard and earn your swags.

9. If you have any Doubts/ Questions/ Suggestions please feel free to talk to the SWOC team. Please feel free to report any malpractices found in server.

Expand All @@ -42,7 +42,7 @@ There is no limit on the number of issues you can work on, but I suggest working

5. **How can I start with SWOC?**

This is one of the most frequently asked questions, Assuming you have registered for SWOC and have completed all the prerequisites like joining the Quine platform, SOWC discord server etc. Please wait until the 1st of January 2024 as the event will start on that day. Till then you can select the project in which you want to contribute and that best suits you.
This is one of the most frequently asked questions, Assuming you have registered for SWOC and have completed all the prerequisites like joining the Quine platform, SWOC discord server etc. Please wait until the 1st of January 2024 as the event will start on that day. Till then you can select the project in which you want to contribute and that best suits you.

To participate in the event, please familiarize yourself with the project codebase. Advanced users can try setting up the project on their local machine. The official start date for the event is on the 1st of January 2024. At this point, you can begin addressing the issues listed in your selected projects. Keep in mind that the process for contributing to a project may vary depending on the project and its admin.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "palettegram",
"description": "Palettegram is a social media application dedicated to professionals like graphic designers, UI/UX designers, Developers, etc. to leverage UI designs, design ideas, UX approaches and color palettes.",
"version": "1.0.2",
"version": "1.0.5",
"private": true,
"homepage": ".",
"engines": {
Expand Down
47 changes: 22 additions & 25 deletions src/app/post/[id]/page.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
'use client'
"use client";

import SinglePost from '@/components/core/posts/SinglePost'
import { useEffect, useState } from 'react';
import SinglePost from "@/components/core/posts/SinglePost";
import { useEffect, useState } from "react";
import { getSinglePost } from "@/backend/posts.api";


type Prop = {
params: {
id: string;
Expand All @@ -24,34 +23,33 @@ interface postType {
}

const PostDisplay = ({ params: { id } }: Prop) => {

const [post,setPost] = useState<postType>({
accountId : "",
postTitle : '',
postImage : [],
colors : [],
comments : [],
likes : [],
$collectionId : '',
$createdAt : '',
$id : ''
})
const [post, setPost] = useState<postType>({
accountId: "",
postTitle: "",
postImage: [],
colors: [],
comments: [],
likes: [],
$collectionId: "",
$createdAt: "",
$id: "",
});

useEffect(() => {
const getPost = async () => {
try {
const res = await getSinglePost(id);
if(res){
if (res) {
setPost({
accountId: res.accountId,
postTitle: res.postTitle,
postImage: res.postImage,
colors: res.colors || [],
comments: res.comments || [],
likes: res.likes,
$id: res.$id || '',
$collectionId: res.$collectionId || '',
$createdAt: res.$createdAt || '',
$id: res.$id || "",
$collectionId: res.$collectionId || "",
$createdAt: res.$createdAt || "",
});
}
console.log(res);
Expand All @@ -61,14 +59,13 @@ const PostDisplay = ({ params: { id } }: Prop) => {
};

getPost();

}, [id]);

return (
<>
<SinglePost singlePost = {post} width = {'w-96'} />
<SinglePost singlePost={post} width={"w-96"} />
</>
)
}
);
};

export default PostDisplay
export default PostDisplay;
1 change: 0 additions & 1 deletion src/app/post/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { Suspense } from "react";
import Loader from "@/app/loading";
import Navbar from "@/components/core/navbar";


export default async function PostLayout({ children }: { children: React.ReactNode }) {
return (
<>
Expand Down
4 changes: 3 additions & 1 deletion src/components/core/createPost/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ const CreatePost = () => {
<form className="p-4" method="post" onSubmit={handleSubmit}>
<div className="mb-2">
{/* <small className="text-slate-400">Character limit is upto {CHAR_LIMIT}</small> */}
<small className="text-slate-400">You have {CHAR_LIMIT -postTitle.length} characters left</small>
<small className="text-slate-400">
You have {CHAR_LIMIT - postTitle.length} characters left
</small>

<textarea
onChange={(event: any) => setPostTitle(event.target.value)}
Expand Down
12 changes: 9 additions & 3 deletions src/components/core/posts/SinglePost.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ type UserBookMarkType = {
export default function SinglePost({
singlePost,
onLikeClick,
width
width,
}: {
singlePost: PostInstanceType;
onLikeClick?: any;
width? : string
width?: string;
}) {
const [userDetails, setUserDetails] = useState<UserDetails | null>(null);
const [comment_message, setComment_message] = useState("");
Expand Down Expand Up @@ -148,7 +148,13 @@ export default function SinglePost({
}, [fetchUserDetails]);

return (
<div className={` ${width ? 'w-96 p-3 m-auto rounded-md shadow dark:shadow-gray-600 mb-4 mt-40 ' : 'p-3 rounded-md shadow dark:shadow-gray-600 mb-4'} `}>
<div
className={` ${
width
? "w-96 p-3 m-auto rounded-md shadow dark:shadow-gray-600 mb-4 mt-40 "
: "p-3 rounded-md shadow dark:shadow-gray-600 mb-4"
} `}
>
<Link
className="flex items-center gap-3 mb-3"
href={`/user/${singlePost && singlePost?.accountId}`}
Expand Down
2 changes: 1 addition & 1 deletion src/components/pages/home/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ function HomePage() {
</p>

<div className="flex justify-center md:justify-start">
{state?.creds.userId && state?.creds.userId !== '' ? (
{state?.creds.userId && state?.creds.userId !== "" ? (
<ButtonLong href="/feed" size="big">
Checkout your feed
</ButtonLong>
Expand Down
Loading
Loading