https://github.com/foss-cell-gecpkd/breakpoint
🌌 A space for YOU to showcase YOUR projects!
https://github.com/foss-cell-gecpkd/breakpoint
listing projects react showcase vite
Last synced: 6 months ago
JSON representation
🌌 A space for YOU to showcase YOUR projects!
- Host: GitHub
- URL: https://github.com/foss-cell-gecpkd/breakpoint
- Owner: FOSS-Cell-GECPKD
- License: gpl-3.0
- Created: 2025-01-01T06:07:06.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-03-19T04:54:17.000Z (7 months ago)
- Last Synced: 2025-03-28T20:05:53.925Z (6 months ago)
- Topics: listing, projects, react, showcase, vite
- Language: TypeScript
- Homepage: https://foss-cell-gecpkd.github.io/Breakpoint/#/
- Size: 924 KB
- Stars: 4
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Breakpoint
*Pause. Build. Inspire*
A space for YOU to showcase YOUR projects!
---
## How to Add Your Project
Welcome! We're excited to showcase your project. Follow these simple steps to add your work to our collection.
### How to Submit
1. Fork the repository
2. Add your project to `data.json`
3. Place your project at the end of the "projects" array, with the given template:
```json
{
"studentName": "Your Full Name",
"projectName": "Your Project Name",
"description": "A brief description of your project (max 100 characters)",
"tags": ["Tag1", "Tag2", "Tag3"], // Choose relevant technologies/categories
"projectLink": "https://your-demo-link.com", // MANDATORY! - Site Link or Github (if any)
"githubLink": "https://github.com/your-username/your-repo",
"image": "https://link-to-your-project-image.com" // Must be a direct image link
}
```
4. Ensure your JSON is valid (you can use [JSONLint](https://jsonlint.com/)) *Optional*
5. Create a Pull Request
### Requirements
- **Image**:
- Must be a direct link (ends with .jpg, .png, .gif)
- Recommended size: 1280x720px
- Max size: 2MB
- Hosted on image hosting services like Postimg, Imgur, or your GitHub repo
- **Description**: Keep it concise and clear
- **Tags**: Use existing tags when possible
- **Links**: Must be valid and accessible
### Common Tags
Here are some commonly used tags:
- Technologies: React, Vue, Angular, Node.js, Python, Java, etc.
- Categories: Web, Mobile, Game, AI, Design, etc.
- Skills: Frontend, Backend, Full Stack, UI/UX, etc.
### Need Help?
- If you're unsure about image hosting, we recommend using [Postimg](https://postimages.org/)
- For JSON validation, use [JSONLint](https://jsonlint.com/)
- If you have questions, open an issue in the repository
## How to run locally?
1. Clone the repo
```sh
git clone https://github.com/FOSS-Cell-GECPKD/Breakpoint
```
2. Install the required packages
```sh
npm i
```
3. Run in development mode
```sh
npm run dev
```
## Technology Used
- Typescript
- Tailwind
- Vite
### Libraries used:
- lucide-react
- framer-motion
- @icons-pack/react-simple-icons
---
Made with 💠by FOSS GEC Palakkad