Skip to content

Commit 61991a5

Browse files
authored
docs: update README.md with some links
1 parent 395c6a2 commit 61991a5

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,47 @@ cd proposalgen
7373
npm install
7474
npm run dev
7575
```
76+
Then visit http://localhost:3000 and start generating proposals!
77+
78+
## 📁 Project Structure
79+
```
80+
ProposalGen/
81+
├── .firebase/ # Firebase configuration files
82+
├── .github/
83+
│ └── workflows/ # GitHub Actions workflows
84+
├── public/ # Static assets (images, fonts, etc.)
85+
├── src/ # Source code
86+
│ ├── app/ # Next.js App Router pages
87+
│ ├── components/ # Reusable React components
88+
│ ├── styles/ # Tailwind and custom styles
89+
│ └── utils/ # Utility functions and helpers
90+
├── .env # Environment variables
91+
├── .eslintrc.json # ESLint configuration
92+
├── .firebaserc # Firebase project settings
93+
├── .gitignore # Git ignored files
94+
├── README.md # Project documentation
95+
├── abstract.pdf # Sample abstract template PDF
96+
├── elegant.pdf # Sample elegant template PDF
97+
├── modern.pdf # Sample modern template PDF
98+
├── apphosting.yaml # Firebase Hosting configuration
99+
├── firebase.json # Firebase configuration
100+
├── firestore.indexes.json # Firestore indexes
101+
├── firestore.rules # Firestore security rules
102+
├── jsconfig.json # JavaScript configuration
103+
├── next.config.mjs # Next.js configuration
104+
├── package-lock.json # Dependency lock file
105+
├── package.json # Project metadata and scripts
106+
├── postcss.config.mjs # PostCSS configuration
107+
└── tailwind.config.js # Tailwind CSS configuration
108+
```
109+
110+
## 🌐 Live Demo
111+
👉 https://proposalgen.vercel.app
112+
113+
## 🪪 License
114+
MIT © [Siddhesh Naik]
115+
116+
## 🙏 Acknowledgements
117+
- [@react-pdf/renderer](https://react-pdf.org/)
118+
- [Google Fonts](https://fonts.google.com/)
119+
- [TailwindCSS](https://tailwindcss.com/)

0 commit comments

Comments
 (0)