Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project Description 🚀 #15

Open
silenteyesoncode opened this issue Apr 22, 2023 · 11 comments
Open

Project Description 🚀 #15

silenteyesoncode opened this issue Apr 22, 2023 · 11 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@silenteyesoncode
Copy link
Member

Description 🚀

Make a project readme where we need to provide description of project like tech stack , dependencies etc.

Files 🚨

Readme.md

Screenshots 📸

Task

Code readme.md

@silenteyesoncode silenteyesoncode added the documentation Improvements or additions to documentation label Apr 22, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Portfolio Apr 22, 2023
@MohamedBenhammouda
Copy link

can i work on it ?

@silenteyesoncode
Copy link
Member Author

Sure, feel free to make PR on this

@MohamedBenhammouda
Copy link

can i have more description to issue ?

@silenteyesoncode
Copy link
Member Author

You wanna work on readme?

@MohamedBenhammouda
Copy link

yes

@silenteyesoncode
Copy link
Member Author

Well start with this, i'll give you more md issues

@MohamedBenhammouda
Copy link

ok

@MohamedBenhammouda
Copy link

Project Name

A brief description of what this project does and what problem it solves.

Table of Contents

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them:

Installation

  1. Clone the repository: git clone https://github.com/your-username/your-project.git
  2. Navigate to the project directory: cd your-project
  3. Install dependencies: npm install

Usage

How to use this app, including any relevant commands and options:

  • npm start: Starts the development server and opens the app in your default browser.
  • npm run build: Builds the app for production to the build folder.
  • npm test: Launches the test runner in the interactive watch mode.

Running the tests

Explain how to run the automated tests for this system:

  • npm test

Deployment

Add additional notes about how to deploy this on a live system.

Built With

  • React - A JavaScript library for building user interfaces
  • Create React App - A tool for creating React apps with no build configuration
  • [Other libraries, frameworks, tools, etc.]

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License.

Acknowledgments

@silenteyesoncode
Copy link
Member Author

Can you please make a pull request regarding this ?

@silenteyesoncode
Copy link
Member Author

@all-contributors please add @hamma741 for Documentation

@allcontributors
Copy link
Contributor

@silenteyesoncode

I've put up a pull request to add @hamma741! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants