You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some corrections and additional text in Acknowledgements section
Signed-off-by: Guillermo D Andrada <[email protected]>
Co-authored-by: Scott Milliorn <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+31-8Lines changed: 31 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,10 +75,10 @@ Check out our [Next.js deployment documentation](https://nextjs.org/docs/deploym
75
75
- Click on the web icon button to create your web app. It will show a text popup `Web`.
76
76
- Register app by giving it a nickname and click `Register app` button.
77
77
- Where package.json is located, in your cli, type `npm i firebase`.
78
-
- Copy configuration file. Make a new file in `src` called `firebase` called `firebase.js`.
78
+
- Copy configuration file. Make a new file in `src` called `firebase.js`.
79
79
- In project root, create a file and name it `.env`.
80
80
- Make sure you add `.env.local` to your `.gitignore` so you don't expose your variables in git repo.
81
-
- Follow the instructions here at <https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables#loading-environment-variables> to add your variables from firebase.js into this file.
81
+
- Follow the [instructions here](https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables#loading-environment-variables) to add your variables from firebase.js into this file.
82
82
83
83
Example...
84
84
@@ -104,16 +104,30 @@ You should now be setup to use Firebase.
104
104
105
105
## Folder Structure
106
106
107
-
The folder structure of this project is organized as follows:
107
+
The project’s folder structure is organized as follows:
108
108
109
109
-`pages`: Contains the Next.js pages for server-side rendering.
110
-
-`components`: Holds the reusable React components.
110
+
-`components`: Holds reusable React components.
111
111
-`lib`: Includes utility functions and modules.
112
112
-`public`: Stores static assets such as images, fonts, and stylesheets.
113
113
-`styles`: Contains global styles and Tailwind CSS configuration.
114
-
-`firebase`: Houses the Firebase configuration and Firebase-related functions.
115
-
116
-
Feel free to modify and expand the folder structure according to your project requirements.
114
+
-`firebase`: Houses Firebase configuration and related functions.
115
+
116
+
You are free to modify or expand the folder structure according to your project’s needs.
117
+
For example, additional subfolders could be organized like this:
118
+
119
+
-`components`
120
+
-`UI`
121
+
-`custom`
122
+
-`partials`
123
+
- ...
124
+
-`public`
125
+
-`assets`
126
+
-`images`
127
+
-`fonts`
128
+
-`gifs`
129
+
- ...
130
+
- ...
117
131
118
132
## Deployment
119
133
@@ -129,7 +143,16 @@ This project is licensed under the MIT License. See the LICENSE file for more de
129
143
130
144
## Acknowledgements
131
145
132
-
This project was created using the Next.js framework and Firebase platform.
146
+
This project was built with the help of several amazing tools, frameworks, and resources:
147
+
148
+
-[Next.js](https://nextjs.org/) – for providing a modern React framework with server-side rendering and powerful features.
149
+
-[Firebase](https://firebase.google.com/) – for authentication, real-time database, and cloud services that simplify app development.
150
+
-[Tailwind CSS](https://tailwindcss.com/) – for a utility-first CSS framework that makes styling fast and consistent.
151
+
-[ESLint](https://eslint.org/) & [Prettier](https://prettier.io/) – for enforcing best practices and maintaining a clean, consistent codebase.
152
+
-[Vercel](https://vercel.com/) – for seamless deployment and hosting tailored to Next.js projects.
153
+
-[Open Source Community](https://github.com/) – for the continuous contributions, packages, and inspiration that make projects like this possible.
154
+
155
+
Special thanks to the Next.js and Firebase teams for their excellent documentation and active communities, which made this starter template easier to create and extend.
0 commit comments