Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
halimahexe authored Feb 16, 2024
1 parent 7af307e commit ea4b5bf
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,43 @@ As part of the preparation for the Founders and Coders bootcamp, we were given t
The requirements are as follows:

### Required features
1. Built with HTML, CSS & JS
1. Code hosted on GitHub
1. Deployed to GitHub Pages
1. Auto-generate multiple colours
1. Allow users to change each colour|
[x] Built with HTML, CSS & JS
[x] Code hosted on GitHub
[x] Deployed to GitHub Pages
[x] Auto-generate multiple colours
[x] Allow users to change each colour|

### Optional features
1. Export colour palette in different formats (e.g. JSON, CSS variables)
1. Generate related colours rather than random (e.g. ascending lightness, complementary hues etc)
1. Save palettes to localStorage
[ ] Export colour palette in different formats (e.g. JSON, CSS variables)
[x] Generate related colours rather than random (e.g. ascending lightness, complementary hues etc)
[ ] Save palettes to localStorage

## Description

This is my attempt at that. I have taken inspiration from [Coolors](https://coolors.co/) and set up a page which has 5 colours that are generated upon loading and whenever the spacebar is pressed.

### Features so far

- Auto-generates five colours on load
- Users can click hex code to bring up a colour picker to change each colour
- On desktop, pressing spacebar will generate a new palette; on mobile, pressing the generate button will do the same
- When hovering over the hex code, the background changes slightly (darker on light backgrounds and lighter on dark backgrounds)
- Added pastel, complementary, analogous and monochromatic colour generators
- Implemented a HSL to Hex conversion function using code from [CSS Tricks](https://css-tricks.com/converting-color-spaces-in-javascript/#aa-hsl-to-rgb) - I felt this was needed as the `input[type="color"]` wasn't registering the HSL codes and the HSL felt quite busy on the page
[x] Auto-generates five colours on load
[x] Users can click hex code to bring up a colour picker to change each colour
[x] On desktop, pressing spacebar will generate a new palette; on mobile, pressing the generate button will do the same
[x] When hovering over the hex code, the background changes slightly (darker on light backgrounds and lighter on dark backgrounds)
[x] Added pastel, complementary, analogous and monochromatic colour generators
[x] Implemented a HSL to Hex conversion function using code from [CSS Tricks](https://css-tricks.com/converting-color-spaces-in-javascript/#aa-hsl-to-rgb) - I felt this was needed as the `input[type="color"]` wasn't registering the HSL codes and the HSL felt quite busy on the page

## WIP

I have worked through all of the required features and some optional features but they do require finessing. The code I have to generate colours seems quite repetitive to me and they don't all work entirely as I'd like. However, I would like to make it an option to export the colour palettes and save them to localStorage.

### Still to come

- Fix monochromatic generator as if the value is beyond 100, it doesn't quite work
- Make it possible to copy specific colours
- Add option to export palettes
- Add option to save palette to localStorage
- Add a modal to tell users how to use the generator
[ ] Fix monochromatic generator as if the value is beyond 100, it doesn't quite work
[ ] Make it possible to copy specific colours
[ ] Add option to export palettes
[ ] Add option to save palette to localStorage
[ ] Add a modal to tell users how to use the generator

### Stretch goals

- Upload photos to pick main colours
- Lock in colours
[ ] Upload photos to pick main colours
[ ] Lock in colours

0 comments on commit ea4b5bf

Please sign in to comment.