Welcome to TECH EATS! Discover and share your favorite dining destinations that you tech people will enjoy while coding If you're a culinary enthusiast, feel free to showcase your delicious recipes here as well.
Although we are trying to make everyone know your favorite food spot or recipe, the main goal of this website and repository is to have you practice open-source contribution with Git and Github. By creating a simple post about your food spot or recipe you will experience what it is like to contribute in Github.
If you are new to Git and GitHub:
- Create a GitHub account for yourself at Github Login and look around if you aren't familiar with GitHub.
- Go through this tutorial on how to use Git: https://guides.github.com/activities/hello-world/
- Download Visual Studio Code, a free code editor: https://aka.ms/vscode
- Once your computer is configured for Git, which might need to be installed separately, visit this GitHub repo while logged in and click 'fork' in the upper right hand corner. A copy of the repo will appear in your account.
- Then you are all set to contribute to this website!
- You have installed and have a working Node.js
- You know how to use markdown (or you can watch this https://youtu.be/bTVIMt3XllM?si=WSJAuVCnB4B2teUq)
Follow these steps:
-
Fork the repository
-
Clone the Repository
git clone <The link from ypur forked GitHub repo>
- Go inside the folder that was cloned from your GitHub account
cd <folder-name>
- Download Dependencies
npm install
- Run the development server
npm run docs:dev
Tags to Choose From
Tag 1 | Tag 2 |
---|---|
Breakfast | Cheap |
Lunch | Medium |
Dinner | Pricy |
Desserts | Budget-Friendly |
Snacks | Great |
- Navigate the folder and find the templates/ folder and you will see two templates. Use the appropriate one
Food Spot | Recipe |
---|---|
food_spot_template.md | recipe_template.md |
- Copy the template then place it inside the src/foods/ folder then rename it to the one you want make it descriptieve. Give it a descriptive file name example. master-buffalo.md
- Replace the values inside the markdown file
- Register your food spot or recipe by editing this file: src/.vuepress/config.js Pick a category for your post according to those listed in the file in the config.js file. Then add it to its respective category as a 'child':
{
title: 'Lunch',
children:[
'master-buffalo',
]
},
Use the same name as your file.
Optional: You may also add an image for your post Add your image inside the src/images/ folder and name it descriptively example. 'master-buffalo.png'
- Stage and Commit your changes
git add .
git commit -m "your message"
git push -u origin main
-
Create a Pull Request in the main branch of this repository.
-
Once approved, you'll see your favorite food spot or recipe on the website!
If you can't follow through on how to create a pull request, you may follow this video as a guide https://youtu.be/rgbCcBNZcdQ?si=9ZoxdZv854o84xRp
I hope with this experience you will now be able to use Git and GitHub for your personal, school, and collaborative projects!
Happy Coding!