toowake-about v3.1.1

About Me Builder Documentation

The About Me Builder is an npm package that allows you to easily create and serve an "About Me" webpage on your local server. This documentation will guide you through the setup and usage of the package.

Installation

To use the About Me Builder, follow these installation steps:

1. Create a new Node.js project or navigate to an existing one.

2. Install the toowake-about npm package by running the following command: npm i toowake-about

Usage

1. Import the toowake-about npm package into your project:

2. Create an instance of the AboutMeBuilder class with your desired options.

3. Configure your "About Me" page using .set methods for each property.

4. To generate the HTML for your "About Me" page, use the .generateHTML() method.

5. Optionally, you can serve your "About Me" page on a local server with a custom port using the .setPort(port) method.

6. Access your "About Me" page by opening a web browser and navigating to http://localhost:3000 (or your custom port).

Example

Here's an example of how to create an "About Me" page using the About Me Builder:

const AboutMeBuilder = require('toowake-about'); //import the npm

const about = new AboutMeBuilder(); //create the about me

about.setName("John Doe") //your name
 .setAge(30) //your age
 .setDescription("Web Developer") //some about you stuff as text
 .setCountry("USA") //the country you come from
 .setLanguages(["English", "Spanish"]) //the languages you speak
 .setHobbies(["Reading", "Hiking", "Coding"]) //your hobbys
 .setPet("Dog") //the pet you have (if you have one)
 .setBirthday({ day: 1, month: 1, year: 1990 }) //your birthday
 .setBackgroundColor('#FF0000') //a custom background color
 .setFontFamily('Arial') //a custom font
 .setTextColor('#0000FF') //a custom text color
 .setTextAlign('center') //where do you want the text?
 .setImage('https://example.com/background.jpg') //the background image
 .setHeader('My Custom About Me Page') //headline
 .setWebsite('https://www.example.com') //your own website
 .setIntroduction('I am a passionate web developer.') //your intro
 .setEducation('B.Sc. in Computer Science') //your education
 .setWorkExperience('Software Engineer') //your job
 .setSkills(['JavaScript', 'React', 'Node.js']) //your skills
 .setLinks([ //custom link 
     { url: 'https://linkedin.com', label: 'LinkedIn' }, //{ url: "any (example.com)", name: "any (linkName)"}
     { url: 'https://github.com', label: 'GitHub' },
 ]);

const html = about.generateHTML(); //generate HTML (not required)
about.setPort(3000); //the port you want to run it on