docs(15): lessons learned
This commit is contained in:
efim
parent
77bcf87cd1
commit
d7bcb418d4
|
|
@ -1,118 +0,0 @@
|
|||
# Frontend Mentor - Multi-step form solution
|
||||
|
||||
This is a solution to the [Multi-step form challenge on Frontend Mentor](https://www.frontendmentor.io/challenges/multistep-form-YVAnSdqQBJ). Frontend Mentor challenges help you improve your coding skills by building realistic projects.
|
||||
|
||||
## Table of contents
|
||||
|
||||
- [Overview](#overview)
|
||||
- [The challenge](#the-challenge)
|
||||
- [Screenshot](#screenshot)
|
||||
- [Links](#links)
|
||||
- [My process](#my-process)
|
||||
- [Built with](#built-with)
|
||||
- [What I learned](#what-i-learned)
|
||||
- [Continued development](#continued-development)
|
||||
- [Useful resources](#useful-resources)
|
||||
- [Author](#author)
|
||||
- [Acknowledgments](#acknowledgments)
|
||||
|
||||
**Note: Delete this note and update the table of contents based on what sections you keep.**
|
||||
|
||||
## Overview
|
||||
|
||||
### The challenge
|
||||
|
||||
Users should be able to:
|
||||
|
||||
- Complete each step of the sequence
|
||||
- Go back to a previous step to update their selections
|
||||
- See a summary of their selections on the final step and confirm their order
|
||||
- View the optimal layout for the interface depending on their device's screen size
|
||||
- See hover and focus states for all interactive elements on the page
|
||||
- Receive form validation messages if:
|
||||
- A field has been missed
|
||||
- The email address is not formatted correctly
|
||||
- A step is submitted, but no selection has been made
|
||||
|
||||
### Screenshot
|
||||
|
||||
|
||||
|
||||
Add a screenshot of your solution. The easiest way to do this is to use Firefox to view your project, right-click the page and select "Take a Screenshot". You can choose either a full-height screenshot or a cropped one based on how long the page is. If it's very long, it might be best to crop it.
|
||||
|
||||
Alternatively, you can use a tool like [FireShot](https://getfireshot.com/) to take the screenshot. FireShot has a free option, so you don't need to purchase it.
|
||||
|
||||
Then crop/optimize/edit your image however you like, add it to your project, and update the file path in the image above.
|
||||
|
||||
**Note: Delete this note and the paragraphs above when you add your screenshot. If you prefer not to add a screenshot, feel free to remove this entire section.**
|
||||
|
||||
### Links
|
||||
|
||||
- Solution URL: [Add solution URL here](https://your-solution-url.com)
|
||||
- Live Site URL: [Add live site URL here](https://your-live-site-url.com)
|
||||
|
||||
## My process
|
||||
|
||||
### Built with
|
||||
|
||||
- Semantic HTML5 markup
|
||||
- CSS custom properties
|
||||
- Flexbox
|
||||
- CSS Grid
|
||||
- Mobile-first workflow
|
||||
- [React](https://reactjs.org/) - JS library
|
||||
- [Next.js](https://nextjs.org/) - React framework
|
||||
- [Styled Components](https://styled-components.com/) - For styles
|
||||
|
||||
**Note: These are just examples. Delete this note and replace the list above with your own choices**
|
||||
|
||||
### What I learned
|
||||
|
||||
Use this section to recap over some of your major learnings while working through this project. Writing these out and providing code samples of areas you want to highlight is a great way to reinforce your own knowledge.
|
||||
|
||||
To see how you can add code snippets, see below:
|
||||
|
||||
```html
|
||||
<h1>Some HTML code I'm proud of</h1>
|
||||
```
|
||||
```css
|
||||
.proud-of-this-css {
|
||||
color: papayawhip;
|
||||
}
|
||||
```
|
||||
```js
|
||||
const proudOfThisFunc = () => {
|
||||
console.log('🎉')
|
||||
}
|
||||
```
|
||||
|
||||
If you want more help with writing markdown, we'd recommend checking out [The Markdown Guide](https://www.markdownguide.org/) to learn more.
|
||||
|
||||
**Note: Delete this note and the content within this section and replace with your own learnings.**
|
||||
|
||||
### Continued development
|
||||
|
||||
Use this section to outline areas that you want to continue focusing on in future projects. These could be concepts you're still not completely comfortable with or techniques you found useful that you want to refine and perfect.
|
||||
|
||||
**Note: Delete this note and the content within this section and replace with your own plans for continued development.**
|
||||
|
||||
### Useful resources
|
||||
|
||||
- [Example resource 1](https://www.example.com) - This helped me for XYZ reason. I really liked this pattern and will use it going forward.
|
||||
- [Example resource 2](https://www.example.com) - This is an amazing article which helped me finally understand XYZ. I'd recommend it to anyone still learning this concept.
|
||||
|
||||
**Note: Delete this note and replace the list above with resources that helped you during the challenge. These could come in handy for anyone viewing your solution or for yourself when you look back on this project in the future.**
|
||||
|
||||
## Author
|
||||
|
||||
- Website - [Add your name here](https://www.your-site.com)
|
||||
- Frontend Mentor - [@yourusername](https://www.frontendmentor.io/profile/yourusername)
|
||||
- Twitter - [@yourusername](https://www.twitter.com/yourusername)
|
||||
|
||||
**Note: Delete this note and add/remove/edit lines above based on what links you'd like to share.**
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
This is where you can give a hat tip to anyone who helped you out on this project. Perhaps you worked in a team or got some inspiration from someone else's solution. This is the perfect place to give them some credit.
|
||||
|
||||
**Note: Delete this note and edit this section's content as necessary. If you completed this challenge by yourself, feel free to delete this section entirely.**
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
# Frontend Mentor - Multi-step form
|
||||
|
||||
|
||||
|
||||
## Welcome! 👋
|
||||
|
||||
Thanks for checking out this front-end coding challenge.
|
||||
|
||||
[Frontend Mentor](https://www.frontendmentor.io) challenges help you improve your coding skills by building realistic projects.
|
||||
|
||||
**To do this challenge, you need a good understanding of HTML, CSS and JavaScript.**
|
||||
|
||||
## The challenge
|
||||
|
||||
Your challenge is to build out this multi-step form and get it looking as close to the design as possible.
|
||||
|
||||
You can use any tools you like to help you complete the challenge. So if you've got something you'd like to practice, feel free to give it a go.
|
||||
|
||||
Your users should be able to:
|
||||
|
||||
- Complete each step of the sequence
|
||||
- Go back to a previous step to update their selections
|
||||
- See a summary of their selections on the final step and confirm their order
|
||||
- View the optimal layout for the interface depending on their device's screen size
|
||||
- See hover and focus states for all interactive elements on the page
|
||||
- Receive form validation messages if:
|
||||
- A field has been missed
|
||||
- The email address is not formatted correctly
|
||||
- A step is submitted, but no selection has been made
|
||||
|
||||
Want some support on the challenge? [Join our Slack community](https://www.frontendmentor.io/slack) and ask questions in the **#help** channel.
|
||||
|
||||
## Where to find everything
|
||||
|
||||
Your task is to build out the project to the designs inside the `/design` folder. You will find both a mobile and a desktop version of the design.
|
||||
|
||||
The designs are in JPG static format. Using JPGs will mean that you'll need to use your best judgment for styles such as `font-size`, `padding` and `margin`.
|
||||
|
||||
If you would like the design files (we provide Sketch & Figma versions) to inspect the design in more detail, you can [subscribe as a PRO member](https://www.frontendmentor.io/pro).
|
||||
|
||||
All the required assets for this project are in the `/assets` folder. The images are already exported for the correct screen size and optimized.
|
||||
|
||||
We also include variable and static font files for the required fonts for this project. You can choose to either link to Google Fonts or use the local font files to host the fonts yourself. Note that we've removed the static font files for the font weights that aren't needed for this project.
|
||||
|
||||
There is also a `style-guide.md` file containing the information you'll need, such as color palette and fonts.
|
||||
|
||||
## Building your project
|
||||
|
||||
Feel free to use any workflow that you feel comfortable with. Below is a suggested process, but do not feel like you need to follow these steps:
|
||||
|
||||
1. Initialize your project as a public repository on [GitHub](https://github.com/). Creating a repo will make it easier to share your code with the community if you need help. If you're not sure how to do this, [have a read-through of this Try Git resource](https://try.github.io/).
|
||||
2. Configure your repository to publish your code to a web address. This will also be useful if you need some help during a challenge as you can share the URL for your project with your repo URL. There are a number of ways to do this, and we provide some recommendations below.
|
||||
3. Look through the designs to start planning out how you'll tackle the project. This step is crucial to help you think ahead for CSS classes to create reusable styles.
|
||||
4. Before adding any styles, structure your content with HTML. Writing your HTML first can help focus your attention on creating well-structured content.
|
||||
5. Write out the base styles for your project, including general content styles, such as `font-family` and `font-size`.
|
||||
6. Start adding styles to the top of the page and work down. Only move on to the next section once you're happy you've completed the area you're working on.
|
||||
|
||||
## Deploying your project
|
||||
|
||||
As mentioned above, there are many ways to host your project for free. Our recommend hosts are:
|
||||
|
||||
- [GitHub Pages](https://pages.github.com/)
|
||||
- [Vercel](https://vercel.com/)
|
||||
- [Netlify](https://www.netlify.com/)
|
||||
|
||||
You can host your site using one of these solutions or any of our other trusted providers. [Read more about our recommended and trusted hosts](https://medium.com/frontend-mentor/frontend-mentor-trusted-hosting-providers-bf000dfebe).
|
||||
|
||||
## Create a custom `README.md`
|
||||
|
||||
We strongly recommend overwriting this `README.md` with a custom one. We've provided a template inside the [`README-template.md`](./README-template.md) file in this starter code.
|
||||
|
||||
The template provides a guide for what to add. A custom `README` will help you explain your project and reflect on your learnings. Please feel free to edit our template as much as you like.
|
||||
|
||||
Once you've added your information to the template, delete this file and rename the `README-template.md` file to `README.md`. That will make it show up as your repository's README file.
|
||||
|
||||
## Submitting your solution
|
||||
|
||||
Submit your solution on the platform for the rest of the community to see. Follow our ["Complete guide to submitting solutions"](https://medium.com/frontend-mentor/a-complete-guide-to-submitting-solutions-on-frontend-mentor-ac6384162248) for tips on how to do this.
|
||||
|
||||
Remember, if you're looking for feedback on your solution, be sure to ask questions when submitting it. The more specific and detailed you are with your questions, the higher the chance you'll get valuable feedback from the community.
|
||||
|
||||
## Sharing your solution
|
||||
|
||||
There are multiple places you can share your solution:
|
||||
|
||||
1. Share your solution page in the **#finished-projects** channel of the [Slack community](https://www.frontendmentor.io/slack).
|
||||
2. Tweet [@frontendmentor](https://twitter.com/frontendmentor) and mention **@frontendmentor**, including the repo and live URLs in the tweet. We'd love to take a look at what you've built and help share it around.
|
||||
3. Share your solution on other social channels like LinkedIn.
|
||||
4. Blog about your experience building your project. Writing about your workflow, technical choices, and talking through your code is a brilliant way to reinforce what you've learned. Great platforms to write on are [dev.to](https://dev.to/), [Hashnode](https://hashnode.com/), and [CodeNewbie](https://community.codenewbie.org/).
|
||||
|
||||
We provide templates to help you share your solution once you've submitted it on the platform. Please do edit them and include specific questions when you're looking for feedback.
|
||||
|
||||
The more specific you are with your questions the more likely it is that another member of the community will give you feedback.
|
||||
|
||||
## Got feedback for us?
|
||||
|
||||
We love receiving feedback! We're always looking to improve our challenges and our platform. So if you have anything you'd like to mention, please email hi[at]frontendmentor[dot]io.
|
||||
|
||||
This challenge is completely free. Please share it with anyone who will find it useful for practice.
|
||||
|
||||
**Have fun building!** 🚀
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
* Frontend Mentor - Multi-step form solution
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: frontend-mentor---multi-step-form-solution
|
||||
:END:
|
||||
This is a solution to the
|
||||
[[https://www.frontendmentor.io/challenges/multistep-form-YVAnSdqQBJ][Multi-step
|
||||
form challenge on Frontend Mentor]]. Frontend Mentor challenges help you
|
||||
improve your coding skills by building realistic projects.
|
||||
|
||||
** Overview
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: overview
|
||||
:END:
|
||||
*** The challenge
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: the-challenge
|
||||
:END:
|
||||
Users should be able to:
|
||||
|
||||
- Complete each step of the sequence
|
||||
- Go back to a previous step to update their selections
|
||||
- See a summary of their selections on the final step and confirm their
|
||||
order
|
||||
- View the optimal layout for the interface depending on their device's
|
||||
screen size
|
||||
- See hover and focus states for all interactive elements on the page
|
||||
- Receive form validation messages if:
|
||||
- A field has been missed
|
||||
- The email address is not formatted correctly
|
||||
- A step is submitted, but no selection has been made
|
||||
|
||||
*** Screenshot
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: screenshot
|
||||
:END:
|
||||
[[screenshot-desktop.png]]
|
||||
[[screenshot-mobile.png]]
|
||||
|
||||
*** Links
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: links
|
||||
:END:
|
||||
- Solution URL
|
||||
- [[https://efim-frontentmentor-multi-step-form.onrender.com][Live Site URL]]
|
||||
|
||||
** My process
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: my-process
|
||||
:END:
|
||||
*** Built with
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: built-with
|
||||
:END:
|
||||
- Semantic HTML5 markup
|
||||
well, i tried, but yeah
|
||||
- TailwinCSS
|
||||
- Mobile-first workflow
|
||||
- Server-side rendering, in Scala and Cask
|
||||
- htmx
|
||||
- Thymeleaf html templates
|
||||
|
||||
|
||||
*** What I learned
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: what-i-learned
|
||||
:END:
|
||||
**** hx-get and hx-post
|
||||
***** How i show correct form stage for each user on same URL
|
||||
on 'index.html' i use "initial loading" element
|
||||
#+begin_src html
|
||||
<section hx-get="/get-form" hx-trigger="load" hx-swap="outerHTML">
|
||||
<!-- here be immediate hx-get for the form. to subscitute the body -->
|
||||
<img class="w-14 text-green-500 fill-current" src="../public/images/tail-spin.svg" alt="loading..." />
|
||||
</section>
|
||||
#+end_src
|
||||
|
||||
This element will do single GET request to server to /get-form
|
||||
And user already has cookie with sessionId set from visiting the root enpoint, which returned 'index.html'
|
||||
|
||||
So request to /get-form already includes 'sessionId' cookie, and server can find \ initialize Answers data for this particular session,
|
||||
and 'currentStep' is part of the Answers
|
||||
|
||||
so reloading 'index.html' would trigger /get-form, which would render correct step.
|
||||
***** hx-post
|
||||
This will make POST request.
|
||||
If we do GET request from <input> only current input value is included, as query para.
|
||||
POST request from <input> or from <form> would include all filelds of the form.
|
||||
|
||||
So form submittion on "Next" and "Back" done via htmx POST requests, which parse and save passed attributes, but also server selects required next form step, renders it and returns for the 'hx-swap="outerHTML"'
|
||||
|
||||
hx-post on <input> allows for 'inline validation' (see useful resources)
|
||||
this allows for validating field value - in isolation or together with all other form field values.
|
||||
|
||||
**** Learned format in which browser sends POST attributes to the server
|
||||
Request payload as text:
|
||||
name=e&email=emails%40la.la&phone=%2B7%20(911)%2084-35644%20ext%20155
|
||||
|
||||
I chose this exercise also because i wanted more experience in working with forms.
|
||||
Single form would still be much nicer, even with htmx, but yeah.
|
||||
Current exercise felt like full-fledged application.
|
||||
|
||||
**** Styling of the checkbox and radiobuttons as big selectable areas
|
||||
This was first time I attempted something like this.
|
||||
Insight was to use <label> as overall container for the input and other data - descriptions and icons.
|
||||
|
||||
Because user clicking on label automatically translates into toggling of the input, no js needed.
|
||||
|
||||
Either hide (for radio button part on step 2) or keep (for checkboxes on step 3) the input, and put descriptions and icons as next element.
|
||||
|
||||
So that =peer-= styling can be used.
|
||||
|
||||
**** htmx inline validation of the phone number field
|
||||
Almost exactly as in example.
|
||||
Separate rest endpoint for the input field, which returns new rendered state.
|
||||
|
||||
hx-post is triggered on input field default trigger = "changed",
|
||||
and i guess only on focus leaving field. So this seems quite efficient.
|
||||
|
||||
This way validation can be done with very heavy libraries and access to DB and such. Over single field, or over all of them at once.
|
||||
Seems unusual, but cool
|
||||
*** Continued development
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: continued-development
|
||||
:END:
|
||||
I want to learn more about Thymeleaf - how to use files for efficient fragment
|
||||
storage. Currently it feels that i have separate files, and it's nice, but some
|
||||
files have several fragments, and maybe need more documentation or markings.
|
||||
|
||||
Look for other templating solutions for java \ scala, maybe there are others
|
||||
with 'fragment' functionality
|
||||
|
||||
Would be nice to refactor the code, to have smaller and more directed files.
|
||||
|
||||
I am also getting better at doing flex \ grid layouts without specific
|
||||
paddings\margins on the lements, but feel that i'm still abusing that, and that
|
||||
future tinkering with layouts could be painful due to free space being
|
||||
constructed from manual paddings\margings
|
||||
|
||||
For htmx - would be nice to learn transition animations, and try to use it in a bigger exercise already.
|
||||
|
||||
*** Useful resources
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: useful-resources
|
||||
:END:
|
||||
- htmx inline validation
|
||||
https://htmx.org/examples/inline-validation/
|
||||
- htmx control of parameters sent with response
|
||||
https://htmx.org/docs/#parameters
|
||||
** Acknowledgments
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: acknowledgments
|
||||
:END:
|
||||
- svg animated spinner - from SamHerbert
|
||||
https://github.com/SamHerbert/SVG-Loaders/tree/master
|
||||
http://samherbert.net/svg-loaders/
|
||||
- tailwind elements - for their example of 'switch styled' checkbox
|
||||
which I used as inspiration for my styling
|
||||
https://tailwind-elements.com/docs/standard/forms/switch/
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 112 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
Loading…
Reference in New Issue