Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wojciechmarek committed May 28, 2023
1 parent 81e139f commit e23fd36
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,42 @@
# Todo List

This project represents modern UI design styles under a to-do list app.
This project represents modern UI design styles under a todo list app.

## Purpose

To collect together all design styles in one place.
Collect all design styles together in one place and learn how to implement them in CSS.

## Demo

A live demo is available at [https://todo-list-rust-theta.vercel.app](https://todo-list-rust-theta.vercel.app).
To change the theme, click the `Settings` button on the right navigation bar. Then, select the style you want to use.

## Design styles

All design styles are written from scratch. This application does not use any UI component library. Currently, the app implements the following design styles:

- Modern Flat Dark
- Modern Flat Light
- Modern Dark
- Modern Light
- Brutalism
- Neubrutalism
- Glassmorphism
- Neobrutalism
- Cardboard
- Glassmorphism
- Claymorphism
- Neumorphism
- Aurora (the dark theme with some subtle vector graphics in the background)

## Screenshot

⚠️ The screenshot below is outdated. It does not show the latest design styles.
![all-in-one](https://github.com/wojciechmarek/todo-list/assets/27026036/3d663019-eef6-469f-9871-df8135bac2f7)


## Used technologies

- 🎁 **Project:** vite, react, typescript
- 🛠️ **Tools:** yarn, eslint, prettier, husky, speedy web compiler, conventional commits, storybook
- 🎨 **Styling:** styled-components by emotion
- 🧪 **Testing:** jest, react-testing-library
- 💎 **Others:** desktop first approach, atomic design, progressive web app
- 💎 **Others:** desktop-first approach, atomic design, progressive web app, docker and dev container

## Storybook

Expand All @@ -49,3 +53,5 @@ To see all components in isolation:
4. Type and run: `yarn` in the root directory.
5. Type and run: `yarn dev` in the root directory.
6. Open `http:https://localhost:5173` in your browser to see the app.

**NOTICE ℹ️:** The repository contains also the **dev container** configuration for Visual Studio Code. If you have the Remote - Containers extension installed, you can run the project in a container instead of installing all dependencies on your local machine.

0 comments on commit e23fd36

Please sign in to comment.