README.md

UI Heat

Author: Dominique Hosea

Date: December 2020

A beginner-friendly and stylish front-end framework for easier web development.

See Docs:

• Storybook
• Documentation

Table of Contents

• UI Heat
  • Table of Contents
  • Homepage
  • Technologies Used
  • Getting Started
  • Data Structure
  • Unsolved Problems
  • Future Enhancements
  • License

Homepage

Link to the Homepage

Technologies Used

This application was developed with React, and styling was done with SASS/SCSS and CSS.

• React (R): A client-side framework for building user interfaces.

Dependencies used:

• SASS/SCSS: A preprocessor scripting language that is interpreted or compiled into Cascading Style Sheets (CSS).

Getting Started

To get started with this project, follow these steps:

1. Clone the repository to your local machine:

   git clone https://github.com/HoseaCodes/ui-library.git

2. Navigate to the project directory:

   cd ui-library

3. Install the project dependencies:

   npm install

4. Start the development server:

   npm start

5. Open your browser and visit http://localhost:3000 to see the application in action.

Data Structure

Explain the data structure or organization of your project if it's relevant.

Unsolved Problems

List any known issues or problems that are yet to be resolved.

Future Enhancements

Here are some future enhancements planned for this project:

• Implement Light and Dark Mode across the entire application.
• Create a Button Component with detailed documentation on how to implement it effectively.

Feel free to contribute to the project by opening issues or submitting pull requests. Your feedback and contributions are highly appreciated!

License

This project is licensed under the MIT License.