📑 How to fastn?

This workshop is a part of the EduHub Roadshow Jaipur organized EduHub Community

The README.md is intentional to assist you the explorer on their way to explore their project while or after the workshop!

📂 File Structure

💻 Project Files

FASTN/
-- ds.ftd - contains some configuration like the typography for the pages, add a button component
-- data.ftd - contains the data that populates the website
-- types.ftd - contains custom record types for the website

index.ftd - the source code for the home page

FASTN.ftd - package management file

⚙️ Other Files

.github/
-- workflows/
---- deploy.yml - github pages deployment action

.vscode/
-- settings.json - contains some vscode settings

.editorconfig - contains basic editor config

.gitignore - mentions the files that ignored by git

renovate.json - created by github app `renovate`, used for dependency upgrades in nodejs and other languages, does nothing in fastn!

README.md - the file you are reading right now!

💻 Technology Used

This project is built to demonstrate the fastn framework and uses the FTD (fifth try document) language since fastn supports it!

It also uses GitHub Actions and GitHub Pages for deployment.

🫣 Demo

View live demo - xkrishguptaa.github.io/workshop-fastn

🛠️ Workshop

• Go to xkrishguptaa/workshop-fastn

  

• Use this template and then create a new repo!

  

• Select the owner to be yourself and the repo name as workshop-fastn

  

• Now, Click on Code and then the Codespace Tab, after that click on the + icon to create a new codespace

• Now you have VSCode on the web to work on this repo 🎉

• Go to FASTN.ftd file

  This file is the package manager, if you gave the repo name anything other than workshop-fastn please update all the times workshop-fastn is written to your repository's name for it to work!

• Open the terminal (CTRL + ```) and run:

  bash
  source <(curl -fsSL https://fastn.com/install.sh) # installs fastn on the codespace
  # restart terminal or run "source ~/.bashrc" on linux
  fastn serve # this will start the fastn server which you can view with the link provided

• Go to FASTN/data.ftd file

• Have a look around the code, try to change the texts and links to make them all yours ✨

• Look at the running version of fastn server and see how it looks 🤓

• Now have a look at index.ftd! This is the real fastn code, the other is just variables. Read it out and I'm sure you'll understand what it is

• Boom! 🔥 you made your very own fastn website

• Now open the terminal again, click on the plus icon (top right of the terminal) to create a new instance

• Run the following commands to commit your changes:

  git add .
  git commit -m "my small mini link in bio"
  git push

• Now go back to your GitHub Repository, on the settings tab, then the pages button on the menu

  

• Now open the select option for the branch and select gh-pages

  

• Save and you are done! Your website will soon be live at YOUR_USERNAME.github.io/workshop-fastn

🔥 Beyond the workshop

• Star the fastn repository
• Join the fastn discord
• Read the fastn for geeks article

🎉 Hope you enjoyed!

That's it for this workshop! Feel free to contact me for any doubts or to show of what you made! 😃