fictional-memory

ES6 & Node.js Professional Readme.md generator

Description

Creating a command-line application that dynamically generates a professional README.md file from a user's input using the Inquire package. This is in order to create professional README files for new projects with ease.

Installation

To use this application, follow these steps:

Clone the repository to your local machine using the following command:

bash Copy code git clone https://github.com/Sooey-99/fictional-memory Navigate to the project directory:

bash Copy code cd fictional-memory Install the required dependencies using npm:

bash Copy code npm install Run the application:

bash Copy code node index.js Follow the on-screen prompts to enter information about your project.

Once you've completed the prompts, the application will dynamically generate a professional README.md file in the root directory of your project.

Usage

To generate a professional README for your project, follow these steps after installing the application:

Open your terminal.

Navigate to the project directory:

bash Copy code cd professional-readme-generator Run the application:

bash Copy code node index.js

Answer the prompted questions about your project. These questions will cover various aspects of your project, including its title, description, installation, usage, license, etc.

After providing all the necessary information, the application will automatically generate a README.md file with the details you provided. You can find the generated README.md file in the root directory of your project.

Open the generated README.md file using your preferred text editor to review and make any additional modifications if needed.

Your professional README is now ready to be included in your project repository.

Credits

This project was made possible with the support and resources from the following:

Edx: Providing initial starter code and valuable guidance. npm js: Utilizing the Inquirer package for interactive command-line prompts. FreeCodeCamp: Following the professional README Guideguide for creating a high-quality and professional README file.

A special thanks to the contributors and maintainers of the above resources for their valuable contributions to the development community.

Badges

Features

Dynamic README Generation: Quickly and easily generate a professional README.md file for your open-source projects.
Interactive Command-Line Interface: User-friendly prompts using the Inquirer package for gathering information about your project.
License Badge Integration: Automatically include a license badge at the top of your README based on your chosen license.
Comprehensive Sections: Generated README includes sections for Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.
Customization: Easily modify the generated README file to suit your project's specific needs after the initial generation.
Credits Section: Acknowledge and credit contributors, libraries, or resources that have played a significant role in your project.
Badges: Include badges for quick visual indicators, such as the license badge or continuous integration status.
Ease of Setup: Simple installation process using npm and intuitive prompts for collecting project details.

Feel free to customize this list based on the specific features and functionalities of your application. This section should provide users with a quick overview of what makes your README generator unique and valuable for their open-source projects.

How to Contribute

We welcome contributions from the community! If you're interested in contributing to the Professional README Generator, please follow these guidelines:

Fork the Repository: Start by forking the repository to your GitHub account. This will create a copy of the project that you can freely experiment with.
Clone the Repository: Clone the forked repository to your local machine using the following command:
```
git clone https://github.com/your-username/professional-readme-generator.git
```
Create a New Branch: Create a new branch for your contributions. It's recommended to use a branch name that reflects the nature of your changes.
```
git checkout -b feature/new-feature
```
Make Changes: Implement your changes or additions to the project. Ensure that your code follows the project's coding standards and guidelines.
Test Your Changes: If applicable, test your changes to ensure that they work as intended.
Commit Your Changes: Commit your changes with a clear and concise commit message.
```
git commit -m "Add feature: your-feature-name"
```
Push to Your Fork: Push your changes to your forked repository on GitHub.
```
git push origin feature/new-feature
```
Create a Pull Request: Go to the original repository on GitHub and create a pull request. Provide a detailed description of your changes and why they should be merged.
Review and Collaboration: Participate in discussions, address feedback, and collaborate with maintainers to get your pull request merged.

Thank you for considering contributing to the Professional README Generator. Your help is greatly appreciated!

Testing

To ensure the proper functionality of the Professional README Generator, you can follow these steps to run tests:

Install Dependencies: If you haven't already, make sure to install the necessary dependencies by running the following command:
```
npm install
```
Run Tests: Execute the test command to run the automated tests:
```
npm test
```
Review Results: The test suite will run, and the results will be displayed in the console. Make sure that all tests pass successfully.
Manual Testing: Additionally, after generating a README file using the application, manually review the generated README.md to ensure that all entered information is correctly incorporated into the different sections.
User Testing: Share the generated README with others or use it in a test project to verify its usability and correctness in various scenarios.

Feel free to report any issues, unexpected behavior, or improvements by creating a new issue or contributing through pull requests. Your feedback is invaluable in enhancing the reliability and effectiveness of the Professional README Generator.

Demo

https://www.youtube.com/watch?v=HauNGD-VR8Q&ab_channel=%C3%89mileSiou