Skip to content

Commit 1edf4f1

Browse files
SwarnimWalavalkarSwarnimWalavalkar
committed
✨ initial commit
0 parents  commit 1edf4f1

File tree

861 files changed

+18145
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

861 files changed

+18145
-0
lines changed

‎.eslintrc.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["next/core-web-vitals", "next/typescript"]
3+
}

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.mp4 filter=lfs diff=lfs merge=lfs -text
2+
*.png filter=lfs diff=lfs merge=lfs -text
3+
*.gif filter=lfs diff=lfs merge=lfs -text

‎.github/workflows/ci-cd.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: CI/CD
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
workflow_dispatch:
9+
10+
env:
11+
NODE_VERSION: '20'
12+
POSTHOG_KEY: ${{ secrets.POSTHOG_KEY }}
13+
14+
jobs:
15+
test:
16+
name: Test
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Use Node.js ${{ env.NODE_VERSION }}
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: ${{ env.NODE_VERSION }}
26+
cache: 'npm'
27+
28+
- name: Install dependencies
29+
run: npm ci
30+
31+
- name: Run type check
32+
run: npx tsc --noEmit
33+
34+
- name: Run linting
35+
run: npx eslint . --ext .ts,.tsx --max-warnings=0
36+
37+
- name: Run tests
38+
run: npm test
39+
40+
build:
41+
name: Build
42+
needs: test
43+
if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
44+
runs-on: ubuntu-latest
45+
46+
steps:
47+
- uses: actions/checkout@v4
48+
49+
- name: Use Node.js ${{ env.NODE_VERSION }}
50+
uses: actions/setup-node@v4
51+
with:
52+
node-version: ${{ env.NODE_VERSION }}
53+
cache: 'npm'
54+
55+
- name: Install dependencies
56+
run: npm ci
57+
58+
- name: Build
59+
run: npm run build
60+
env:
61+
NEXT_PUBLIC_POSTHOG_KEY: ${{ secrets.POSTHOG_KEY }}
62+
NEXT_PUBLIC_POSTHOG_HOST: ${{ secrets.POSTHOG_HOST || 'https://app.posthog.com' }}
63+
64+
deploy:
65+
name: Deploy
66+
needs: build
67+
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
68+
runs-on: ubuntu-latest
69+
70+
steps:
71+
- uses: actions/checkout@v4
72+
73+
- name: Use Node.js ${{ env.NODE_VERSION }}
74+
uses: actions/setup-node@v4
75+
with:
76+
node-version: ${{ env.NODE_VERSION }}
77+
cache: 'npm'
78+
79+
- name: Install dependencies
80+
run: npm ci
81+
82+
- name: Build
83+
run: npm run build
84+
env:
85+
NEXT_PUBLIC_POSTHOG_KEY: ${{ secrets.POSTHOG_KEY }}
86+
NEXT_PUBLIC_POSTHOG_HOST: ${{ secrets.POSTHOG_HOST || 'https://app.posthog.com' }}
87+
88+
# Add your deployment steps here
89+
# Example for Vercel:
90+
# - name: Deploy to Vercel
91+
# uses: amondnet/vercel-action@v20
92+
# with:
93+
# vercel-token: ${{ secrets.VERCEL_TOKEN }}
94+
# vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
95+
# vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
96+
# working-directory: ./
97+
# vercel-args: '--prod'

‎.gitignore‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# deps
2+
/node_modules
3+
4+
# generated content
5+
.contentlayer
6+
.content-collections
7+
.source
8+
9+
# test & build
10+
/coverage
11+
/.next/
12+
/out/
13+
/build
14+
*.tsbuildinfo
15+
16+
# misc
17+
.DS_Store
18+
*.pem
19+
/.pnp
20+
.pnp.js
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
25+
# others
26+
.env*.local
27+
!.env.local.example
28+
.vercel
29+
next-env.d.ts
30+
.env.local.example

‎README.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Devfolio Documentation
2+
3+
This is a modern documentation site built with [Fumadocs](https://fumadocs.vercel.app) and Next.js, featuring analytics, user feedback, and more.
4+
5+
## Features
6+
7+
- 📊 **Analytics Integration** - Tracks page views, time on page, and user interactions
8+
- 👍 **Helpful Rating System** - Users can rate documentation pages
9+
- 🤖 **Chatbot Integration** - AI-powered assistance (coming soon)
10+
- 📱 **Mobile Responsive** - Works on all devices
11+
- 🚀 **CI/CD Pipeline** - Automated testing and deployment
12+
13+
## Getting Started
14+
15+
### Prerequisites
16+
17+
- Node.js 18+ and npm/yarn/pnpm
18+
- A PostHog account for analytics
19+
20+
### Installation
21+
22+
1. Clone the repository
23+
```bash
24+
git clone https://github.com/your-username/devfolio-docs.git
25+
cd devfolio-docs
26+
```
27+
28+
2. Install dependencies
29+
```bash
30+
npm install
31+
# or
32+
yarn install
33+
# or
34+
pnpm install
35+
```
36+
37+
3. Set up environment variables
38+
```bash
39+
cp .env.local.example .env.local
40+
```
41+
Update `.env.local` with your PostHog credentials:
42+
```env
43+
NEXT_PUBLIC_POSTHOG_KEY=your_posthog_project_key
44+
NEXT_PUBLIC_POSTHOG_HOST=https://app.posthog.com # or your self-hosted instance
45+
```
46+
47+
4. Run the development server
48+
```bash
49+
npm run dev
50+
# or
51+
yarn dev
52+
# or
53+
pnpm dev
54+
```
55+
56+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
57+
58+
## Development
59+
60+
### Available Scripts
61+
62+
- `npm run dev` - Start development server
63+
- `npm run build` - Build for production
64+
- `npm start` - Start production server
65+
- `npm test` - Run tests
66+
- `npm run lint` - Run ESLint
67+
- `npm run type-check` - Check TypeScript types
68+
69+
## Deployment
70+
71+
### Vercel
72+
73+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fyour-username%2Fdevfolio-docs&project-name=devfolio-docs&repository-name=devfolio-docs)
74+
75+
### Manual Deployment
76+
77+
1. Build the application:
78+
```bash
79+
npm run build
80+
```
81+
82+
2. Start the production server:
83+
```bash
84+
npm start
85+
```
86+
87+
## Analytics
88+
89+
This project uses [PostHog](https://posthog.com) for analytics. The following events are tracked:
90+
91+
- Page views
92+
- Time spent on page
93+
- Document helpfulness ratings
94+
- Search queries (coming soon)
95+
- Chatbot interactions (coming soon)
96+
97+
## Contributing
98+
99+
1. Fork the repository
100+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
101+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
102+
4. Push to the branch (`git push origin feature/amazing-feature`)
103+
5. Open a Pull Request
104+
105+
## License
106+
107+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
108+
109+
## Acknowledgements
110+
111+
- [Fumadocs](https://fumadocs.vercel.app) - Documentation framework
112+
- [Next.js](https://nextjs.org) - React framework
113+
- [PostHog](https://posthog.com) - Product analytics
114+
- [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework

‎content/docs/guide/Projects/adding-managing-projects.mdx‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Adding and Managing Your Existing Projects
3+
description: Add a project to showcase on your Devfolio profile 🌟
4+
---
5+
6+
## Adding a Project
7+
8+
Follow these steps to add a project to your Devfolio profile:
9+
10+
1. Head over to [**My Projects**](https://devfolio.co/my-projects).
11+
2. Click on **"Add a Project"**
12+
3. Choose whether you're adding the project for a hackathon or as a side project.
13+
14+
<Callout type="info" title="Active Hackathon Submission">
15+
If you see an option to link to an active hackathon, it's because you're currently participating in one where submissions are open. If you don’t see it, it means either the submission window is closed or you're not enrolled in any ongoing hackathon.
16+
</Callout>
17+
18+
<img src="/assets/forguide.gif" alt="Starting a Side Project" />
19+
<p align="center"><i>Starting a Side Project</i></p>
20+
21+
4. Fill in the required project details:
22+
23+
<img src="/assets/PROJECT.gif" alt="Filling project form" />
24+
25+
### Fields you'll fill in:
26+
27+
- Name of project
28+
- Tagline
29+
- The problems it solves
30+
- Challenges you ran into
31+
- Technologies you used
32+
- Links (GitHub, deployed site, etc.)
33+
- Video demo
34+
- Project screenshots or images
35+
36+
5. Click **Preview**, then **Publish** — and you’re live! 🎉
37+
38+
39+
40+
## Project Details Page
41+
42+
Your project can be accessed via the Projects tab or the My Devfolio tab by clicking in the top right corner on your Devfolio username.
43+
44+
<img src="/assets/part2.gif" alt="Access your project from your Devfolio dashboard" />
45+
46+
<img src="/assets/pika-1693145728672-1x.png" alt="My Devfolio View" />
47+
48+
49+
50+
## Project Stats
51+
52+
You can check the Views, Likes, and Comments of your project once you've uploaded it.
53+
54+
<img src="/assets/9.gif" alt="Project engagement and share options" />
55+
<p align="center"><i>Share your project on Twitter, LinkedIn, or copy the link</i></p>
56+
57+
58+
59+
## Update Project
60+
61+
Through the 'Project' tab, you can even update your projects and can tell your project viewers about the recent updates you made.
62+
63+
<img src="/assets/image (298).png" alt="Project update UI" />
64+
65+
### Here’s how you add updates:
66+
67+
<img src="/assets/6.gif" alt="Adding updates to project" />
68+
<p align="center"><i>Announce changes or additions via updates</i></p>

‎content/docs/guide/Projects/index.mdx‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Projects
3+
description: Explore how Devfolio helps you showcase your work through projects 🏗️
4+
---
5+
6+
7+
Devfolio — as the name suggests, a portmanteau of **Developer** and **Portfolio** — is envisioned as a platform where developers can showcase their work to the world: whether it’s a hiring manager, a teammate, or a curious friend.
8+
9+
The best way to do this, apart from building out [your profile](your-dev-profile/), is to add projects.
10+
11+
Your **Projects** act as a living record of your skills and experiences — whether it’s a weekend side project, an open source contribution, or something you built at a hackathon.
12+
13+
<Callout type="info" title="Hackathon Submissions">
14+
Projects submitted during Devfolio-hosted hackathons are automatically linked to your profile. You don’t need to add them manually.
15+
</Callout>
16+
17+
That said, we encourage you to go beyond hackathons — add personal projects, experiments, learnings, or even work-in-progress ideas. It all adds up to a stronger portfolio 💪
18+
19+
20+
21+
## What This Section Covers
22+
23+
- [Viewing Projects](/docs/guide/Projects/view-submissions/) by other builders
24+
- Adding and managing your existing projects
25+
- Using the **Inspire Me** feature to find project ideas
26+
- Reporting projects for moderation (if needed)

‎content/docs/guide/Projects/inspire-me.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Inspire Me
3+
description: Confused about what to build? Devfolio has got you covered! 🤝🏻
4+
---
5+
6+
<Callout title="Where to find it" type="info">
7+
<code>Inspire Me</code> is available under the <strong>Project</strong> tab.
8+
</Callout>
9+
10+
<img src="/assets/IDEA.gif" alt="Inspire Me Feature Preview" />
11+
<p align="center"><i>Browse and explore ideas from other hackers</i></p>
12+
13+
14+
15+
### 🚀 What you can do with Inspire Me
16+
17+
- Browse through a variety of ideas
18+
- See the hackers who are working on an idea
19+
- Start working on a selected idea
20+
- Submit your own idea for others to explore
21+
22+
23+
24+
## ✍️ Start Working on an Idea or Submit Your Own
25+
26+
Feeling inspired? Just name your project and dive in! You can also submit your idea — and once it’s verified by Devfolio, it will appear in the global idea feed.
27+
28+
<img src="/assets/final.gif" alt="Submit or Start an Idea" />
29+
<p align="center"><i>Start working on a project or submit your own idea</i></p>

‎content/docs/guide/Projects/meta.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"title": "Projects",
3+
"description": "Adding and managing Projects.",
4+
"icon": "Building",
5+
"pages": [
6+
"view-submissions",
7+
"adding-managing-projects",
8+
"inspire-me",
9+
"report-a-project"
10+
]
11+
}

0 commit comments

Comments
 (0)