Update README with Getting Started Guide - Githubissues

daabChingrii / website

1 stars 3 forks source link

Update README with Getting Started Guide #11

Open all3n49 opened 3 weeks ago

all3n49 commented 3 weeks ago

Description

Add a Getting Started section to the README.md file. This section should provide new users with a simple and clear way to start using the project.

Requirements

Installation: Provide step-by-step instructions on how to install the project.
Running the Project: Include commands for starting the project locally.
Examples: Offer examples of how to use key features of the project.

Additional Notes

Make sure to test the installation steps to ensure they are accurate.
Use screenshots or gifs if helpful for better understanding.

Labels

Hacktoberfest, documentation, good first issue

ken-980 commented 3 weeks ago

Pls assign it to me, this is my first time contributing i will be glad

ken-980 commented 3 weeks ago

I have noticed the project does not build successfully, i can work on that also. Please i need clarification on the examples requirements

amaan-bhati commented 3 weeks ago

@ken-980 The task is to develop a comprehensive README.md file for this project. Begin by introducing the technology stack, which consists of Next.js for the framework, TypeScript for strong typing, and TailwindCSS for styling. Then, include a step-by-step guide on how to clone and set up the project on a local environment, covering any prerequisites or dependencies required. Finally, provide an in-depth explanation of the folder structure, describing the purpose of each main directory and how they contribute to the overall functionality and organization of the codebase. This README should serve as a thorough guide for new developers to understand the project setup and architecture.

ken-980 commented 3 weeks ago

Thank you for the explanation, I will get to it

ken-980 commented 3 weeks ago

@amaan-bhati, running npm install fails Screenshot from 2024-11-06 16-58-32

amaan-bhati commented 3 weeks ago

@ken-980 try running npm install --legacy-peer-deps or npm install --force, make sure you are inside the project folder while you run this command.

ken-980 commented 3 weeks ago

Sure thank you. So should i use "npm install --legacy-peer-deps" instead of "npm install", when setting up the project locally in the readme i am working on?