Skip to content

Commit 8fe16cf

Browse files
GuilloSGitmilliorn
andauthored
Update README.md (#284)
Some corrections and additional text in Acknowledgements section Signed-off-by: Guillermo D Andrada <[email protected]> Co-authored-by: Scott Milliorn <[email protected]>
1 parent 3a71440 commit 8fe16cf

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ Check out our [Next.js deployment documentation](https://nextjs.org/docs/deploym
7575
- Click on the web icon button to create your web app. It will show a text popup `Web`.
7676
- Register app by giving it a nickname and click `Register app` button.
7777
- 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`.
7979
- In project root, create a file and name it `.env`.
8080
- 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.
8282

8383
Example...
8484

@@ -104,16 +104,30 @@ You should now be setup to use Firebase.
104104

105105
## Folder Structure
106106

107-
The folder structure of this project is organized as follows:
107+
The project’s folder structure is organized as follows:
108108

109109
- `pages`: Contains the Next.js pages for server-side rendering.
110-
- `components`: Holds the reusable React components.
110+
- `components`: Holds reusable React components.
111111
- `lib`: Includes utility functions and modules.
112112
- `public`: Stores static assets such as images, fonts, and stylesheets.
113113
- `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+
- ...
117131

118132
## Deployment
119133

@@ -129,7 +143,16 @@ This project is licensed under the MIT License. See the LICENSE file for more de
129143

130144
## Acknowledgements
131145

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.
133156

134157
Resources
135158

0 commit comments

Comments
 (0)