Code Monkey home page Code Monkey logo

project-vault's Introduction

Project-Vault

How to Add Your Project to the Repository

To contribute your project, follow these steps:

  1. Navigate to the src > components folder and locate ProjectData.js.

  2. Inside ProjectData.js, you'll find a set of key-value pairs representing project information.

{
    "id": "<add your project's unique identifier>",
    "type": "<select a project type, e.g., Full stack, Backend, Web>",
    "project_name": "<enter your project's name>",
    "tech_stack": [
       "<list the technologies and frameworks used, e.g., 'React', 'HTML'>"
    ],
    "description": "<provide a concise and descriptive 1-2 line overview>",
    "author": "<mention the team members' names and surname initials>",
    "link": "<insert the link to your well-maintained GitHub repository>",
    "imgsrc": "<use a URL shortener for the project image/preview link>",
    "year": "<mention the year the project was created>",
    "majorProject" : "<true || false>"
},

Make sure to fill in the corresponding details accurately for your project as this will help maintain consistency and organization within the repository.

Repo maintainers

project-vault's People

Contributors

maaz25925 avatar codex108 avatar anaskhan28 avatar alfiyasiddique avatar drasticcoder avatar vitthalgund avatar

Stargazers

Dhruv K Jain avatar

Watchers

 avatar

project-vault's Issues

Feat: Making home page responsive

The home page (Home.jsx) which currently contains the Navbar and WhyMatter components is static.

Add the necessary CSS for different screen sizes.

Current state:

Desktop -

image

Mobile -

image

This is an awesome good first issue to try out for everyone.

Feat : Adding Home Page along with all the functionalities

1. Design and Content from Figma:

  • Refer to the Figma design file for the visual layout, colors, typography, and content arrangement.
    Pay close attention to spacing, alignment, and any visual elements presented in the design.
    Component Bifurcation:

  • Divide the webpage into separate components to ensure clarity and avoid confusion during development.
    Identify components such as Navbar, Hero section, Why Does It Matter section, and Footer section.

2.Navbar & Footer component.

  • Implement the design of the footer with appropriate content, links, and any other information required.
    Ensure that footer links are working correctly and lead to relevant pages or external sites.
    Hero Section Component:

  • HeroSection.
    Implement the design of the hero section with the main heading, subheading, and any accompanying visual elements.
    Make sure the hero section content is responsive and adjusts well on different screen sizes.
    Why Does It Matter Section Component:

  • Why Matter Section. (add a suitable name)
    Implement the design of the "Why Does It Matter" section, including headings, content, and any images or icons.
    Ensure that the section's content is responsive and maintains its layout on various devices.
    Responsive Design:

  • Use CSS media queries to adjust styles, layout, and spacing as the screen size changes.
    File Naming Conventions:

Follow a consistent and clear file naming convention for your components, styles, and other assets.
Create separate files for each component to keep your code organized and maintainable.

Adding the Navigation Bar

Navigation Bar

we can add a navigation bar to the Project-Vault Website containing the following links:

  1. Different Social Media Handles of DTC
  2. DTC Main website

Add a search bar

You can add a search bar so it is easier to reach projects in a paced manner.

Category Filter.

A drop-down type of filter (not necessary, you may chose a different style if it's easier for the user to navigate around).

Maybe something like this.

image

On the other hand, you can choose if you want it to be a major project or not.

image

This can be placed besides the existing filter in my opinion, but you can choose for yourself as well.

This can be further extended by utilizing the information provided with each project like the tech stack filter and whatnot; similar to GitHub which has multiple filters to apply from...

Better Search.

The search bar finds the projects by a perfectly matching string and the output is affected by white-space.

When you search for the project name as it is, it works perfectly fine.


Example 1:

image

Example 2:

image


But when I type in:

image

And what if I do this:

image


I hope the problem is clear through the images and search queries.

What I would suggest to fix this is when processing the search query of the user, remove the white-spaces as well as remove the white-spaces of the project titles.

The removal of white-spaces would only be when the process of cross-checking would be there and otherwise they can be stored normally as they are.

Now I understand that the code behind the scenes searches in project name, description and tech stack used which is why this is a suggestion.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.