Hi 👋

You may be wondering, wtf is this github repo. This is a template. A template for all of you, who wants to have a decent project README. It won't make your project amazing by default, but it will for sure make it stand out from the rest of the default bundler readme.

How to use this?

You are free to clone this file, download it, contribute to it, steal it, ignore it or do whatever you think is neccessary. Just make sure, that you clean up all the intro stuff before using this template.

----- TEMPLATE STARTS HERE -----

[YOUR_PROJECT_NAME]

[PLACE_FOR_YOUR_IMAGE]

[PLACE_TO_ADD_LINK_FOR_DEPLOYED_VERSION]

[Add some introduction about your project. What is the purpose of it? What problem does it solve? What it does?]

Example:

{YOUR_PROJECT_NAME} is a web application to check the weather in any location in world!

• Enter the name of the city you want to know the weather for.
• Get the weather for your current location.
• Get the weather forecast for up to 4 weeks!

Technologies in use / Tech Stack / Built with

[Add the main technologies you used to build this project]

Example:

• TypeScript
• React
• Redux
• TailwindCSS
• Node.js
• Express

Installation

[Explain how to install your project locally. Technical person would want to clone your repo, check code and run it locally]

Example:

To install {YOUR_PROJECT_NAME} locally, please follow the steps below:

• Clone repo to your machine
• Open the root of the project and install all dependencies with npm i / yarn
• Project has various scripts to run:
  • npm start - running local version
  • npm run test - run tests

What I have learned

[Tell more about what you have learned while building this project]

Example:

While I was building {YOUR_PROJECT_NAME} I have learned the fundamentals of React and Redux. I learned what is the difference between React Context API and Redux, and what works best for my current application. I have used Reat hooks like useEffect, useState. It was my first project using TypeScript and I have learned a lot about TypeScript type definitions and fundamentals.

What issues have I faced and how I resolved them

[Tell what was hard in the process of building the project. Tell about where have you feel stuck and how did you overcome this.]

Example:

When I tried to connect to the third-party API, I was not sure how to use fetch and what is the difference between async/await, what are Promises and how to use them. After some Googling I found out the MDN documentation about async/await and tried to use it in practice - it worked!

Source

[Is this project was part of the course? Is it your own idea? Is it came from community?]

Example:

This project is done as part of the SheCodes course curriculum.

---- TEMPLATE ENDS HERE ----

This is definitely way better than your generic Create React App README. Use it, make your projects stand out from the rest.

Contribution

Feel free to contribute in any way possible. To contribute, please do the following:

• git clone this repo
• Go to the root folder of this project and checkout to another branch
• `git checkout {your-nickname}-rename-title
• Do your stuff
• git add .
• git commit -m "any descriptive message"
• git push origin {your-nickname}-rename-title
• Submit a PR for review

For beginners with love